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;

基本语法

编写Java程序时，应注意以下几点：

· 大小写敏感：Java是大小写敏感的，这就意味着标识符Hello与hello是不同的。

· 类名：对于所有的类来说，类名的首字母应该大写。如果类名由若干单词组成，那么每个单词的首字母应该大写，例如 MyFirstJavaClass 。

· 方法名：所有的方法名都应该以小写字母开头。如果方法名含有若干单词，则后面的每个单词首字母大写。

· 源文件名：源文件名必须和类名相同。当保存文件的时候，你应该使用类名作为文件名保存（切记Java是大小写敏感的），文件名的后缀为.java。（如果文件名和类名不相同则会导致编译错误）。

· 主方法入口：所有的Java 程序由public static void main(String []args)方法开始执行。

 

Java标识符

Java所有的组成部分都需要名字。类名、变量名以及方法名都被称为标识符。

关于Java标识符，有以下几点需要注意：

· 所有的标识符都应该以字母（A-Z或者a-z）,美元符（$）、或者下划线（_）开始

· 首字符之后可以是任何字符的组合

· 关键字不能用作标识符

· 标识符是大小写敏感的

· 合法标识符举例：age、$salary、_value、__1_value

· 非法标识符举例：123abc、-salary