乔尼丶

  博客园  :: 首页  :: 新随笔  :: 联系 :: 订阅 订阅  :: 管理

双人项目的代码规范

关于双人项目的代码规范,我有以下几点需要说明。
这次是由我和马金龙合作的双人项目,有关的代码的规范,我们做出如下的几点。

1.文件注释:所有的源文件都应该在开头有一个注释:文件名、作者、修改日期:

2.包和引入语句:第一个非注释行是包语句。

3. 类或接口注释:在类、接口定义之前应当对其进行注释,包括类、接口的描述、最新修改者;

4. 类的(静态)变量:首先是类的公共变量,随后是保护变量,再后是包一级别的变量(没有访问修饰符),最后是私有变量;

5. 实例变量:首先是公共级别的,随后是保护级别的,再后是包一级别的(,最后是私有级别的;

6. 普通方法:方法应该按功能分组。

7. 缩进:程序块要采用缩进风格编写,缩进只使用TAB键,不能使用空格键(编辑器中请将TAB设置为4格);方法体的开始、类的定义、以及if、for、do、while、switch、case语句中的代码都要采用缩进方式;

8. 对齐:程序块的分界符左大括号"{" 和右大括号"}"都另起一行,应各独占一行并且位于同一列,同时与引用它们的语句左对齐;对齐只使用TAB键,不使用空格键;不允许把多个短语句写在一行中,即一行只写一条语句;if、for、do、while、case、switch、default等语句自占一行。

9. 换行:一行的长度超过100个字符需要换行,换行规则如下:
在一个逗号后面断开;
在一个操作符前面断开;
长表达式要在低优先级操作符处划分新行;
新行缩进2个TAB。

10. 间隔:类、方法及相对独立的程序块之间、变量说明之后必须加空行;

11. 命名规则:变量采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写;常量全部采用大写,单词间用下划线隔开;

 

posted on 2020-10-20 19:51  乔尼丶  阅读(102)  评论(0)    收藏  举报