Skip to content

Latest commit

 

History

History
87 lines (53 loc) · 3.1 KB

codestyle.md

File metadata and controls

87 lines (53 loc) · 3.1 KB

代码风格

  • 缩进

1.缩进采用4个空格,禁止使用tab字符。 说明:如果使用tab缩进,必须设置1个tab为4个空格。IDEA设置tab为4个空格时,请勿勾选Use tab character;而在eclipse中,必须勾选insert spaces for tabs。

2.使用for,if等嵌套结构时在其下方缩进,使得程序看起来更好看

  • 变量命名

1.参数名、成员变量、局部变量都统一使用lowerCamelCase风格,必须遵从驼峰形式。

正例:targetPath/originPath

2.较少采用不规范的缩写,避免望文不知义。

反例: AbstractClass“缩写”命名成AbsClass;condition“缩写”命名成 condi,此类随意缩写严重降低了代码的可阅读性。

  • 每行最多字符数

1.每行最多95字符数

2.当程序代码过长时要在适当的位置回车分行,使整体程序看起来美观。规则:第二行相对第一行缩进4个空格,从第三行开始,不再继续缩进,参考示例。运算符与下 文一起换行。方法调用的点符号与下文一起换行。在多个参数超长,逗号后进行换行。在括号前不要换行,见反例。

正例:
StringBuffer sb = new StringBuffer();
//超过120个字符的情况下,换行缩进8个空格,并且方法前的点符号一起换行
sb.append("zi").append("xin")...
        .append("huang")...
	    .append("huang")...
	    .append("huang");
反例:
StringBuffer sb = new StringBuffer();
//超过95个字符的情况下,不要在括号前换行
sb.append("zi").append("xin")...append
	    ("huang");
  • 函数最大行数

1.函数的最大行数为75行

  • 函数、类命名

1.函数名和类名使用UpperCamelCase风格,必须遵从驼峰形式。函数名用动词打头,以名词结尾的形式(少数会只有动词命名),使函数功能更容易理解。

  • 常量

1.常量命名要全大写

2.如果变量值仅在一个范围内变化用Enum类。如果还带有名称之外的延伸属性,必须使用Enum类,下面正例中的数字就是延伸信息,表示星期几。

正例:publicEnum{MONDAY(1),TUESDAY(2),WEDNESDAY(3),THURSDAY(4),FRIDAY(5),SATURDAY(6), SUNDAY(7);}
  • 空行规则

1.函数之间用空行隔开,使程序更美观显得不拥挤

2.类之间也要用空行隔开

  • 注释规则

1.类、类方法的注释必须使用/*内容/格式,不得使用//xxx方式。

2.注释掉的代码尽量要配合说明,而不是简单的注释掉。

说明:代码被注释掉有两种可能性: 1)后续会恢复此段代码逻辑。 2)永久不用。 前者如果没有备注信息,难以知晓注释动机。后者建议直接删掉(代码仓库保存了历史代码)。

  • 操作符前后空格

1.可以使得代码更美观更容易看清

  • 其他规则

1.对于“明确停止使用的代码和配置”,如方法、变量、类、配置文件、动态配置属性等要坚决从程序中清理出去,避免造成过多垃圾。

2.在需要使用变量时,我会在使用前定义,而不是在使用时才定义,这样当一些需要用到其值时,无法获得的情况。