java编程规范92465

java编程规范92465

ID:19880757

大小:70.00 KB

页数:19页

时间:2018-10-07

java编程规范92465_第1页
java编程规范92465_第2页
java编程规范92465_第3页
java编程规范92465_第4页
java编程规范92465_第5页
资源描述:

《java编程规范92465》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库

1、JAVA编程规范1.命名规范定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性)1.1.基本规则较短的单词可通过去掉“元音”形成缩写;较长的单词可取单词的头几发符的优先级,并用括号明确表达式的操作顺序,避免使用默认优先级。1.2.具体规则ØPackage的命名:应该都是由一个小写单词组成。如:packagecom.neu.utilØClass的命名:必须由大写字母开头而其他字母都

2、小写的单词组成,对于所有标识符,其中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母。如: publicclassThisAClassName{}ØClass变量的命名:必须用一个小写字母开头。后面的单词用大写字母开头。如:userName,thisAClassMethodØStaticFinal变量的命名:应该都大写,并且指出完整含义。如:  /**DBConfigPATH**/   publicstaticfinalStringDB_CONFIG_FILE_PATH="com.neu.

3、etrain.dbconfig";Ø参数的命名:和变量的命名规范一致。Ø数组的命名:应该总是用下面的方式来命名:  byte[]buffer;  而不是:bytebuffer[];Ø方法的参数:使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字:  SetCounter(intsize){    this.size=size;  }1.变量定义规范Ø去掉没必要的公共变量。Ø构造仅有一个模块或函数可以修改、创建,而其余有关模块或函数只访问的公共变量,防止多个不同模块或函数都可以修改、

4、创建同一公共变量的现象。Ø仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。Ø明确公共变量与操作此公共变量的函数或过程的关系,如访问、修改及创建等。Ø当向公共变量传递数据时,要十分小心,防止赋与不合理的值或越界等现象发生。Ø防止局部变量与公共变量同名。Ø仔细设计结构中元素的布局与排列顺序,使结构容易理解、节省占用空间,并减少引起误用现象。Ø结构的设计要尽量考虑向前兼容和以后的版本升级,并为某些未来可能的应用保留余地(如预留一些空间等。Ø留心具体语言及编译器处理不同数据类型的原则及有

5、关细节。Ø严禁使用未经初始化的变量。声明变量的同时对变量进行初始化。Ø编程时,要注意数据类型的强制转换。1.代码编写格式Ø代码样式:代码应该用unix的格式,而不是windows的(比如:回车变成回车+换行)Ø文档化:必须用javadoc来为类生成文档。不仅因为它是标准,这也是被各种java编译器都认可的方法。使用@author标记是不被推荐的,因为代码不应该是被个人拥有的。Ø缩进:应该是每行2个空格.不要在源文件中保存Tab字符.在使用不同的源代码管理工具时Tab字符将因为用户设置的不同而扩展

6、为不同的宽度.Ø如果你使用UltrEdit作为你的Java源代码编辑器的话,你可以通过如下操作来禁止保存Tab字符,方法是通过UltrEdit中先设定Tab使用的长度室2个空格,然后用Format

7、TabstoSpaces菜单将Tab转换为空格。Ø页宽:应该设置为80字符.源代码一般不会超过这个宽度,并导致无法完整显示,但这一设置也可以灵活调整.在任何情况下,超长的语句应该在一个逗号或者一个操作符后折行.一条语句折行后,应该比原来的语句再缩进2个字符.Ø{}对:{}中的语句应该单独作为一行.例如

8、,下面的第1行是错误的,第2行是正确的: if(i>0){i++};//错误,{和}在同一行 if(i>0){ i++};      //正确,{单独作为一行,}语句永远单独作为一行. }语句应该缩进到与其相对应的{那一行相对齐的位置。Ø括号:左括号和后一个字符之间不应该出现空格,同样,右括号和前一个字符之间也不应该出现空格.下面的例子说明括号和空格的错误及正确使用: CallProc(AParameter);//错误CallProc(AParameter);//正确Ø不要在语句中使用无意义的括

9、号.括号只应该为达到某种目的而出现在源代码中。下面的例子说明错误和正确的用法: if((I)=42){//错误-括号毫无意义if(I==42)or(J==42)then//正确-的确需要括号1.注释规范ØJava的语法与C++及为相似  //注释一行  /*......*/注释若干行/**......*/注释若干行,并写入javadoc文档Ø注释要简单明了。  StringuserName=null;//用户Ø边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。Ø在

当前文档最多预览五页,下载文档查看全文

此文档下载收益归作者所有

当前文档最多预览五页,下载文档查看全文
温馨提示:
1. 部分包含数学公式或PPT动画的文件,查看预览时可能会显示错乱或异常,文件下载后无此问题,请放心下载。
2. 本文档由用户上传,版权归属用户,天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。
3. 下载前请仔细阅读文档内容,确认文档内容符合您的需求后进行下载,若出现内容与标题不符可向本站投诉处理。
4. 下载文档时可能由于网络波动等原因无法下载或下载错误,付费完成后未能成功下载的用户请联系客服处理。