5.《重学 JAVA》-- 编码规范
对于编码规范来说,对于每一个人来说都是要精进的。
对于初学者方面来说看《阿里巴巴的编程规范》,接下来可以看《代码整洁之道》来对自己的代码审视。
一、命名规范
JAVA 的常量命名规范采用于驼峰(驼峰命名法)。
驼峰分为两种
大驼峰:大驼峰所有单词的首字母为大写,例如:ClassRoom。
小驼峰:小驼峰第一个单词的首字母小写,其余首字母大写,例如:myClassRoom。
类名:采用大驼峰的形式例如:TrainNumber.java
接口名:采用大驼峰的形式 TrainNumberService.java
文件名:采用大驼峰的形式 TrainNumberSound.mp3
变量名:采用小驼峰的形式例如:trainNumber
方法名:采用小驼峰的形式例如:sumTrainNumber
包名:采用于全部小写的形式例如:net.yangpeng.weiwu
常量名:我们在第四节中的静态常量就采用于全大写的形式,如果多个单词的话,建议用下划线进行分割。例如:January 1 月 February 2 月等。
对于常量来说:很多公司会自己创建常量类
例如日期的常量类:年月日等。
例如月份的常量类:January February 等。
例如数字的常量类:One Twodeng。
这样在我们日常编码中如果有使用到常量相关,可以直接引用常量,不建议直接在代码中编写魔法值。
二、注释相关规范
java 中的注释分为三种
1.单行注释
2.多行注释 例如:
3.文档注释
文档注释建议在接口上添加,当类调用接口时,不用进入接口层就可以看见接口文档注释相关信息。
三、常用注释标签
@author : 说明是类和接口的作者
@deprecated :说明类,接口或成员已经废弃
@param:说明方法参数
@return:说明返回值
@see:参考另一个主题的链接
@exception:说明方法抛出的异常类
@version:类或接口的版本
版权声明: 本文为 InfoQ 作者【杨鹏Geek】的原创文章。
原文链接:【http://xie.infoq.cn/article/9bfb99563336d8fa9b71495bf】。文章转载请联系作者。
评论