java编码规范(公司)

《java编码规范(公司)》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、中唐软件JAVA编码规范中唐软件第6页共6页中唐软件1.1、命名规范定义这个规范的目的是让项目中所有的文档格式的统一，增加可读性。命名过程中，尽量使用英文单词，较短的单词可通过去掉“元音”形成缩写，较长的单词可取单词的头几个字符，命名的目的是简单易懂，不要过于啰嗦。nPackage命名Package的名字应该都是由一个小写单词组成。例：packagecom.neu.utilnClass的命名Class的名字必须由大写字母开头而其他字母都小写的单词组成,其中包含的所有单词都应紧靠在一起，而且大写中间单词的首字母。例：publicclassThisACla

2、ssName{}nClass变量和方法的命名变量和方法的名字必须用一个小写字母开头。后面的单词用大写字母开头例：userName，thisAClassMethod。nstaticfinal变量的命名staticfinal变量的名字应该都大写，并且指出完整含义。例：/***数据库配置文件路径**/publicstaticfinalStringDB_CONFIG_FILE_PATH="com.neu.etrain.dbconfig";n参数的命名参数的名字必须和变量的命名规范一致。中唐软件第6页共6页中唐软件使用有意义的参数命名，如果可能的话，使用和要赋值

3、的字段一样的名字：publicvoidsetSize(intsize){this.size=size;}n数组的命名数组应该总是用下面的方式来命名：byte[]buffer;而不是：bytebuffer[];方法的参数1.1、变量定义规范1.去掉没必要的公共变量。2.仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。3.明确公共变量与操作此公共变量的方法或过程的关系，如访问、修改及创建等。4.防止局部变量与公共变量同名。5.严禁使用未经初始化的变量。声明变量的同时对变量进行初始化。1.2、代码编写格式n缩进缩进应该是每行一个Tab字符。在

4、源文件中保存Tab字符，Tab字符占用2个字符。n页宽页宽应该设置为80字符。n{}对“{}”中的语句应该单独作为一行。例如：if(i>0){中唐软件第6页共6页中唐软件i++;}//{单独作为一行‘}’语句永远单独作为一行。如果‘}’语句应该缩进到与其相对应的‘{’那一行相对齐的位置。n括号左括号和后一个字符之间不应该出现空格,同样,右括号和前一个字符之间也不应该出现空格。例如:CallProc(AParameter);不要在语句中使用无意义的括号。括号只应该为达到某种目的而出现在源代码中。下面的例子说明错误和正确的用法:if((i)=42){//错

5、误-括号毫无意义if(i==42)or(j==42)then//正确-的确需要括号1.1、注释规范Java的注释有四种：//注释一行……………………………………………………(1)/*......*/注释若干行………………………………………(2)/**......*/注释若干行，并写入javadoc文档…………(3)@Override………………………………………………………(4)1.注释要简单明了。StringuserName=null;//用户2.边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。3.在必要的地方注释，注释量要适中

6、。注释的内容要清楚、明了，含义准确，防止注释二义性。保持注释与其描述的代码相邻，即注释的就近原则。4.对代码的注释应放在其上方相邻位置。中唐软件第6页共6页中唐软件1.全局变量要有较详细的注释，包括对其功能、取值范围、哪些方法存取它以及存取时注意事项等的说明。2.在每个源文件的头部要有必要的注释信息，包括：文件名；版本号；作者；生成日期；模块功能描述（如功能、主要算法、内部各部分之间的关系、该文件与其它文件关系等）；主要方法清单及本文件历史修改记录等。/***@版权信息:NeusoftIIT*@工程名:eTrain*@JDK版本:jdk6.0.1*@注

7、释:configpath*@详细设计编号:1.01**/3.在每个方法的前面要有必要的注释信息，包括：方法名称；功能描述；输入、输出及返回值说明；抛出异常说明；调用关系及被调用关系说明等。/***Description:提款*@param证书信息*@param业务PO*@returnString*@exception*@修改人:张三*@修改时间:2008-11-17*/publicStringcheckout(HashtablehtCart,OrderBeanorderBean)throwsException{}1.1、排版规范1.在Eclipse开发

8、环境下使用统一的排版格式（快捷键：Ctrl+Shift+f）。中唐软件第6页共6页中唐软件中唐