Java编码规范笔记

编码规范没有对错，是大家约定的编程习惯。

目录结构

java代码

静态资源

代码排版

• 方法名和其后的括弧之间不应该有空格。
• 缩进采用四空格。
• 方法局部变量声明和语句之间一空行。
• 方法两个逻辑段之间一空行。
• 方法每个参数逗号后一空格。
• 所有二元操作数空格隔开。

a = (a + b) / (c * d);

• 单行不超过80个字符。断行规则如下。

1. 在逗号后，操作符前。
2. 较高层次断行。
3. 断行对齐，比上行缩进4字符。

注释规则

• 类注释需列出功能、版本信息、日期、作者和版权声明。
• 如对文件进行了修改需说明修改目的、修改日期、修改人并变更版本信息。
• 中文写出方法参数和返回值的含义。
• 块注释前一空行。
• 单行注释位与所描述的内容之前，注释之前一空行。一行写不完，需用块注释。
• 对变量或常量的简短注释位与代码的右端，且留有足够空白。

命名规则

• 包名小写
• 类名规则。
  – 用英文，不用拼音。
  – 用名词，每词首字母大写。
  – 不要使用复数。
  – 不用A，An，The开头。
• 接口命名前加I。
• 方法名为动词加名词对，第一个单词首字母小写，其余首字母大写。
• 除临时变量外，不能使用单字符作为变量名。
• 常量全大写，单词间用下划线隔开。
• 所有布尔型get方法需用is作为前缀，is小写，其余首字母大写
• 方法规模限制在200行以内,一个方法完成一个功能
• 多重运算需用括号标出优先级
• 对字符串有附加操作用StringBuffer