杂谈之Java命名规范与注释

Java之大，一锅炖不下！

在学习Java时，我们其实不是先学习基本语法和底层原理，而是在潜移默化中，悄悄形成的命名规范。

比如，上个月博主接手了一个离职同事的项目黑盘...运行代码，完美！功能运行流畅。

嘿！突然页面接口报异常，根据异常信息博主去对应的文件打断点跟了一下代码，找到了原因所在，刚准备修改时，看到具体代码的实现逻辑，我懵逼了...零注释行，首字母拼音缩写命名法（心里直呼，大佬，大佬，你怎么可以为难胖虎啊！）

在当天下班前，我修复了BUG。第二天还是被项目老大骂了一通，完全不给我解释的机会
（零注释行，首字母拼音缩写），之后还是按照阿里规范改了一版规范化的代码。所以提醒各位刚入行的萌新或者打算学习Java为自己的主要开发语言的同胞们提醒一下，命名规范！命名规范！命名规范！重要的事情说三遍！

接下来，我们开始切入正题！

一、命名规范

1、 项目名全部小写，包名全部小写

2、 类名首字母大写，如果类名由多个单词组成，每个单词的首字母都要大写。

如：public class MyFirstClass{}

3、 变量名、方法名首字母小写，如果名称由多个单词组成，每个单词的首字母都要大写（驼峰命名法）。

如：int index=0;

       public void toString(){}

4、 用final static等方式定义的常量名全部大写

如：public static final String GAME_COLOR=”RED”;

5、除了以下的while，for等循环的情况外，尽量不用i，j这类没有意义的字母来命名。

如：while（i++ < num）{ 实现业务 }

       或

      for（int i = 0; i < 100; i++） { 实现业务 }

6、所有命名规则必须遵循以下规则：

1)、名称只能由字母、数字、下划线、$符号组成

2)、不能以数字开头

3)、名称不能使用JAVA中的关键字。

4)、坚决不允许出现中文及拼音命名。

 

二、注释规范

1、   类注释

在每个类前面必须加上类注释，注释模板如下：

/**

* Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.

* FileName: Test.java

* 类的详细说明

*

* @author 类创建者姓名
    * @Date    创建日期

* @version 1.00

*/

2、   属性注释

在每个属性前面必须加上属性注释，注释模板如下：

/** 提示信息 */

private String strMsg = null;

3、   方法注释

在每个方法前面必须加上方法注释，注释模板如下：

/**

* 类方法的详细使用说明

*

* @param 参数1 参数1的使用说明

* @return 返回结果的说明

* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

*/

4、   构造方法注释

在每个构造方法前面必须加上注释，注释模板如下：

/**

* 构造方法的详细使用说明

*

* @param 参数1 参数1的使用说明

* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

*/

5、方法内部注释

在方法内部使用单行或者多行注释，该注释根据实际情况添加。

如：//背景颜色

       Color bgColor = Color.RED

最后，再献给诸位同胞一个蓝buff，那就是万能的阿里巴巴Java 开发手册（点击）

ps：其中，包含了eclipse以及IDEA的p3c插件，阿里巴巴开发手册gitbook版以及PDF版