锐客网

  1. 首页 > 睿知 > it技术 > >

代码合规检查java 代码合规检查工具 开源( 二 )

IT技术代码


/**
* Copy Right Information : Neusoft IIT
* Project : eTrain
* JDK version used : jdk1.3.1
* Comments : config path
* Version : 1.01
* Modification history :2003.5.1
* Sr Date Modified By WhyWhat is modified
* 1. 2003.5.2 Kevin Gao new
**/
在每个函数或过程的前面要有必要的注释信息，包括：函数或过程名称；功能描述；输入、输出及返回值说明；调用关系及被调用关系说明等
/**
* Description :checkout 提款
* @param Hashtable cart info
* @param OrderBean order info
* @return String
*/
public String checkout(Hashtable htCart,
OrderBean orderBean)
throws Exception{
}
javadoc注释标签语法
@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@see 对类、属性、方法的说明 参考转向，也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说明
3、命名规范
定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失 。（这些规范并不是一定要绝对遵守 ， 但是一定要让程序有良好的可读性）较短的单词可通过去掉元音形成缩写；要不然最后自己写的代码自己都看不懂了，那可不行 。
较长的单词可取单词的头几发符的优先级，并用括号明确表达式的操作顺序 ， 避免使用默认优先级 。
使用匈牙利表示法
Package 的命名
【代码合规检查java 代码合规检查工具 开源】Package 的名字应该都是由一个小写单词组成 。
package com.neu.util
Class 的命名
Class 的名字必须由大写字母开头而其他字母都小写的单词组成,对于所有标识符，其中包含的所有单词都应紧靠在一起，而且大写中间单词的首字母 。
public class ThisAClassName{}
Class 变量的命名
变量的名字必须用一个小写字母开头 。后面的单词用大写字母开头
userName , thisAClassMethod
Static Final 变量的命名
static Final 变量的名字应该都大写，并且指出完整含义 。
/**
*DBConfig PATH
**/
public static final String
DB_CONFIG_FILE_PATH =com.neu.etrain.dbconfig;
参数的命名
参数的名字必须和变量的命名规范一致 。
数组的命名
数组应该总是用下面的方式来命名：
byte[] buffer;
而不是：
byte buffer[];
方法的参数
使用有意义的参数命名 ， 如果可能的话，使用和要赋值的字段一样的名字：
SetCounter(int size){
this.size = size;
}
4、文件样式
所有的 Java(*.java) 文件都必须遵守如下的样式规则：
版权信息
版权信息必须在 java 文件的开头，比如：
/*
* Copyright ? 2000 Shanghai XXX Co. Ltd.
* All right reserved.
*/
其他不需要出现在 javadoc 的信息也可以包含在这里 。
Package/Imports
package 行要在 import 行之前，import 中标准的包名要在本地的包名之前，而且按照字母
顺序排列 。如果 import 行中包含了同一个包中的不同子目录，则应该用 * 来处理 。
package hotlava.net.stats;
import java io.*;
import java.util.Observable;
import hotlava.util.Application;
这里 java 。io.* 使用来代替InputStream and OutputStream 的 。
Class
接下来的是类的注释，一般是用来解释类的 。
/**
* A class representing a set of packet and byte counters

推荐阅读


上一篇：品牌网店如何引流，网店引流方式

下一篇：linux如何命令去录音，linux 音频