其他分享
首页 > 其他分享> > 代码风格笔记

代码风格笔记

作者:互联网

因为在写学校的课程设计作业时,深受代码命名和代码规范的困扰,在简单学习了"java开发手册",还有其他博客的代码规范经验后,做了一些笔记.

 

1.代码中的命名不能以下划线和美元符开始,也不能用下划线和美元符结束.

2.类名用大驼峰法,使用名词或名词短语.

3.方法名使用小驼峰法,使用动词或者动词短语,动宾短语.

4.参数名,成员变量名,局部变量名使用小驼峰法,由单词组成,避免使用单个字符的变量名.

5.常量命名全部大写,单词用下划线隔开,语义要表达完整,不用在意名字长度.

6.杜绝不规范的缩写,避免望文不知意.

7.在命名时,为了达到代码直解释,尽量使用完整的单词组合来表达.

8.在常量和变量命名时,表示类型的名词放词尾.

9.如果大括号内为空,简洁的写成"{}",大括号中间不需要换行和空格.

10.在非空代码块中,左大括号'{'前,有一个空格,不换行,左大括号后换行.

11.右大括号'}'前换行,如果右大括号后面右else语句,则else空一格,不换行.

12.表示终止的右大括号必须换行.

13.if/for/while/switch/do等保留字与括号之间必须加空格.

14左小括号和左小括号右边相邻字符之间没有空格,右小括号和右小括号左边相邻字符之间也不出现空格.

15.任何 二目,三目运算符的左右两边都要加一个空格.如'=','&&','==',及加减乘除符号等.

16.采用4个空格缩进.

17.注释的'//'与注释内容之间有且仅有一个空格.

18.在强制类型转换时,右括号与强制转换值之间不需要任何空格隔开.

19.单行字符数不超过120个,超过需要换行.换行规则如下:

1)第二行相对第一行缩进 4 个空格,从第三行开始,不再继续缩进.

2)运算符与下文一起换行。

3)方法调用的点符号与下文一起换行。

4)方法调用中的多个参数需要换行时,在逗号后进行。

5)在括号前不要换行.

20.方法参数在定义和传入时,多个参数的逗号后面必须加空格.

21.单个方法的总行数不超过80行.

22.不同逻辑,不同语义,不同业务的代码之间插入一个空行分隔开.

23.类.类属性.类方法的注释必须使用 Javadoc 规范,使用/*内容/格式,不能使用//方式.

24.所有类都必须添加创建者和创建日期.

25.方法内部的单行注释,在被注释语句的上方另起一行,用//注释,方法内部多行注释用/**/注释,两个方法都要注意与代码对齐.

 

标签:注释,换行,代码,笔记,空格,风格,小括号,大括号
来源: https://www.cnblogs.com/iczichu/p/15627365.html