java的命名规范与注释规范

一、java命名规范

1、项目名全部小写

2、包名全部小写

3、类名首字母大写，若类名由多个单词构成，每个单词首字母大写，即大驼峰命名

public class HelloWorld(){ }

4、变量名、方法名首字母小写，若其由多个单词构成，每个单词首字母大写，即小驼峰命名法

public void sayHello(){ }

String userName ="luis";

5、常量名全部大写

public static final String ATHOR="luis";

6、以上所有命名遵循规则：

• 名称只能由数字、字母、下划线、$符组成
• 不能以数字开头
• 不能是有Java的关键字和保留字
• 严禁使用汉字和拼音

二、java注释规范

注释分为文档注释(/** */ )、行注释(//) 、块注释(/* */ )三种。

其中文档注释可用来注释类、接口、静态方法、成员方法、静态变量、成员变量、常量

块注释可用来注释文件头、算法实现、方法中的复杂代码块、修改记录

行注释一般用来注释局部变量

下面将对常用的四种注释进行展示：

1、类注释

在每个类前面加上类注释，注释内容包括类或接口名，类和接口功能描述，作者，创建日期，所属公司、版本等：

/**
* @description：测试类
* @ClassName：HelloWorld.java
* @author luis
* @Date   2018-7-16 18:10:31
* @version 1.00
*/

2、属性注释

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

/** 字符串信息 */
private String strMsg = null;

3、方法注释

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

/**
* 类方法的详细使用说明
* @param 参数1 参数1的使用说明
* @param 参数2 参数1的使用说明
* @return 返回结果的说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/

4、 构造方法注释

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

/**
* 构造方法的详细使用说明
* @param 参数1 参数1的使用说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/

5、 方法内部注释

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

//背景颜色
Color bgColor = Color.RED

以上为企业在java开发过程中需遵守的命名规范与注释规范，希望能够对开始java学习的我们有所帮助。