最近打算学习java，每种语言都有自己的一些规范，想学好一门语言并且写出来的代码能被他人读懂，有必要了解一下这些东西，于是上网搜了搜，记录下来以备后用；
命名规范
- 项目名称全部小写；
- 包名全部小写；
-
类名首字母大写，如果类名由多个字母组成，每个首字母都需要大写；
image.png
- 变量名和方法 名首字母小写，如果由多个单词组成，其后的每个首字母都需要大些；
int index=0;
public void toString(){}
- 常量名称全部大写
public static final String SKY_COLOR=“BLUE”;
- 所有命名规则必须遵循一下规则：
1）名称只能由字母，数字，_和$组成；
2）不能以数字开头；
3）名称不能用JAVA的关键字；
4）坚决不允许出现中文或拼音；
注释规范
- 类注释
在每个类前面必须加类注释，注释模板如下：
/**@progrma: class_One
*@description:this is a class
*@author:shd
*@create:2018-10-04 19:07
*/
可以这样设置：
image.png
/**@progrma: ${PROJECT_NAME}
*@description:${DESCRIPTION}
*@author:shd
*@create:${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
*/
- 属性注释
在每个属性前面加上属性注释，注释模板如下：
/** 提示信息*/
private String strMsg= null；
- 方法注释
**
*@Description:$description$
*@Param:$parm$
*@return:$returns$
*@Author:shd
*@Date:$date$
*@Time:$time$
**/
在每个方法前面必须加上方法注释，注释模板如下：
具体设置，请点击传送门
网友评论