qileilove

blog已经转移至github,大家请访问 http://qaseven.github.io/

Java代码规范那些事

Java开发中所要遵守的编码规范大体上有如下7点。命名规范、注释规范、缩进排版规范、文件名规范、声明规范、语句规范以及编程规范。

  1、命名规范

  (1)所有的标示符都只能用ASCⅡ字母(A-Z或a-z)、数字(0-9)和下划线“_”。

  (2)一个唯一包名的前缀总是全部小写的字母。例如:www.tonysun.cc

  (3)类名是一个名词,采用大小写混合的方式,每个单词的首字母大写。例如:Tony。

  (4)接口的大小写规则与类名相似:例如:Tony。

  (5)方法名是一个动词或动词词组,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。例如:setNeekeName(String neekeName)。

  (6)变量名第一个字母小写,任何中间单词的首字母大写。变量名应简短且可以顾名思义,易于记忆。例如:neekeName、neekeAddress。避免单个字符的变量名,除非是一次性的临时变量。

  (7)常量的声明应该全部大写,每个单词之间用“_”连接。例如:final String WWW_TONY_CN = “www.tonysun.cc”;

  2、注释规范

  (1)注释尽可能使用“//”;对于所有的javadoc的注释则使用“/** */”;而临时对代码块进行注释尽量使用“/* */”。

  (2)所有的源文件都应该在开头有一个注释,其中列出文件名、日期和类的功能概述。

  (3)每个方法必须添加文档注释(类的main()方法除外)。

  (4)每个属性必须添加注释。

  (5)代码中至少包含15%的注释。

  (6)注释使用中文。

  3、缩进排版规范

  (1)避免一行的长度超过60个字符。

  (2)使用Eclipse的源代码的格式化功能完成代码的缩进排版(Ctrl+Shift+F)。

  4、文件名规范

  (1)一个Java源文件只能存储一个Java类。

  (2)文件名与Java类名相同。

  (3)一个类文件的代码行不超过200行。

posted on 2011-12-05 13:47 顺其自然EVO 阅读(94) 评论(0)  编辑  收藏


只有注册用户登录后才能发表评论。


网站导航:
 
<2011年12月>
27282930123
45678910
11121314151617
18192021222324
25262728293031
1234567

导航

统计

常用链接

留言簿(54)

随笔分类

随笔档案

文章分类

文章档案

搜索

最新评论

阅读排行榜

评论排行榜