Java命名规范

转载：https://www.cnblogs.com/zshibo/p/8007123.html

Java命名规范

一、命名规范

1、 项目名全部小写

2、 包名全部小写

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

如：public class MyFirstClass{}

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

如：int index=0;

       public void toString(){}

5、 常量名全部大写

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

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

转载 https://www.cnblogs.com/niceboat/p/6180625.html  （有修改）

Java命名规范

驼峰法则：

将所有字母都小写(包括缩写)，然后将单词的第一个字母大写。

每个单词的第一个字母都大写，来得到大驼峰式命名。

除了第一个单词，每个单词的第一个字母都大写，来得到(小)驼峰式命名。

 

为避免歧义，文中小驼峰法统称为驼峰法，大驼峰/帕斯卡法统称为大驼峰法则。

 

1. Package

项目包命名规则：<域名反转>.<团队名>.<项目名>。相关项目可使用<域名反转>.<团队名>.<父项目名>.<子项目名>的命名法则。

命名必须全部使用英文小写字母，禁止使用“下划线”等字符。（除常量外，Java命名习惯中均不推荐使用下划线等字符）

示例：

com.cnblogs.niceboat.soyteam.anticorruptionsystem

 

2. Class/Object、Interface

类和接口使用大驼峰命名法

抽象类使用“Abstract”做为类命名的开头

Exception类命名使用“Exception”做为类命名的结尾

Test类使用“Test”做为类命名的结尾

在面向接口编程中，接口的实现类的命名规则为：<接口名>+"Impl"。禁止使用匈牙利命名法。

示例（正确）：

接口	实现类
IHandsomeProvider	HandsomeProviderImpl

 

3. Method/Function

方法的命名使用驼峰法，一般使用动词或动词+名词组合。

设置/获取某个值的方法，命名为setV/getV

返回长度的方法，命名为length

判断布尔值的方法，命名为isV

将对象转换为某个特定类型的方法应该命名为toT

示例：

getSecretStage()

length()

isEmpty()

toSpecialFormat()

 

 

4. Variable

变量的命名使用驼峰法

示例：

OpenId

 

常量命名使用大写字母并用下划线分割

示例：

MAX_SUITABLE_SIZE

 

 

关于驼峰法则的具体命名规范(尤其是涉及到单词缩写)，参见此表：

原文	驼峰法则	大驼峰法则	不推荐
XML HTTP request	xmlHttpRequest	XmlHttpRequest	XMLHTTPRequest
new customer ID	newCustomerId	NewCustomerId	newCustomerID
inner stopwatch	innerStopwatch	InnerStopwatch	innerStopWatch
support IPv6 on iOS	supportIpv6OnIos	SupportIpv6OnIos	supportIPv6OniOS
Anglo-Saxon England	angloSaxonEngland	AngloSaxonEngland	Anglo-SaxonEngland

 

 

   

 

 

参考：

Google Java Style Guide   https://google.github.io/styleguide/javaguide.html