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

时间: 2024-10-01 07:09:00

JAVA命名、注释规范的相关文章

java代码注释规范-----转载-----http://blog.csdn.net/shiyuezhong/article/details/8205281/

1 代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率.也是程序代码可维护性的重要环节之一.所以我们不是为写注释而写注释.下面说一下我们在诉求网二期开发中使用的代码注释规范,供大家参考下. 2 3 原则: 4 1.注释形式统一 5 6 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释.如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范. 7 8 2.注释内容准确简洁 9 10 内容要简单.明了.含

Java命名默认规范

学习java的时候,命名的大小写经常弄混,所以在此总结一下java命名规范 1.project(项目名) 说法不一,暂定小写,eg:arraytest 2.包名 小写,eg:package arrayapp; 还可以分部分起名,域名起头,eg:com.frontfree.javagroup; 3.类名/接口名 首字母大写,eg:public class ArrayApp{} 4.方法名 首字母小写,其他单词首字母大写,eg:public void getName(){} 一般情况下,获取方法用g

Java基础——注释规范

一.注释格式分类: 1.单行(single-line)注释://-- 2.块(block)注释:/*--*/ 3.文档注释:/**--*/ javadoc有如下: 二.加注释的场景: 1. 基本注释(必须加) (a)类(接口)的注释 (b)构造函数的注释 (c)方法的注释 (d)全局变量的注释 (e)字段/属性的注释 2. 特殊必须加注释(必须加) (a)典型算法 必须有注释. (b)在代码不明晰处必须有注释. (c)在代码修改处加上修改标识的注释. (d)在循环和逻辑分支组成的代码中加注释.

java代码注释规范

1.单行(single-line)注释:“//……” 2.块(block)注释:“/*……*/” 3.文档注释:“/**……*/” 4.javadoc 注释标签语法 @author   对类的说明 标明开发该类模块的作者 @version   对类的说明 标明该类模块的版本 @see     对类.属性.方法的说明 参考转向,也就是相关主题 @param    对方法的说明 对方法中某参数的说明 @return   对方法的说明 对方法返回值的说明 @exception  对方法的说明 对方法可

Java注释规范整理

在软件开发的过程中总是强调注释的规范,但是没有一个具体的标准进行说明,通常都是在代码编写规范中简单的描述几句,不能作为一个代码注释检查的标准和依据,做什么都要有一个依据吗:),现在我特整理了一个<Java的注释规范>,内容来自网络.书籍和自己的实际积累. JAVA注释规范 版本/状态 作者 版本日期 1.0 ghc 2008-07-02 一.背景 1.当我们第一次接触某段代码,但又被要求在极短的时间内有效地分析这段代码,我们需要什么样的注释信息? 2.怎么样避免我们的注释冗长而且凌乱不堪呢? 

javaSE之java命名规范

java命名规范 1.Java中的名称规范: (1)包名全是小写:xxyyzz: (2)类名接口名:首字母大写:XxxYyy: (3)变量名和函数名:变量名不能是关键字:多单词组成时,第一个单词首字母小写,第二个单词开始每个单词首字母大写xxxYyyZzz.(驼峰表示法) (4)常量名:所有字母都大写.多单词时每个单词用下划线链接,XXX_YYY_ZZZ. 2.Java中书写程序的规范: (1)类包含方法,方法包含语句: (2)类名通常由英文单词组成(有意义的名称,可增加阅读性),首字母要大写:

再温习JAVA命名规范

Java编程规范整理 基本命名规范 包命名 包名按照域名的范围从大到小逐步列出,恰好和Internet上的域名命名规则相反. 由一组以"."连接的标识符构成,通常第一个标识符为符合网络域名的两个或者三个英文小写字母. PeopleTestPageXMLExample 类,接口命名 类的名字必须由大写字母开头而单词中的其他字母均为小写:如果类名称由多个单词组成,则每个单词的首字母均应为大写例如TestPage:如果类名称中包含单词缩写,则这个所写词的每个字母均应大写,如:XMLExamp

java命名规范和编程技巧

一个好的java程序首先命名要规范. 命名规范 定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,方便维护等作用 Package 的命名 Package 的名字应该都是由一个小写单词组成. Class 的命名 Class 的名字必须由大写字母开头而其他字母都小写的单词组成 Class 变量的命名 变量的名字必须用一个小写字母开头,后面的单词用大写字母开头. Static Final 变量的命名  Static Final 变量的名字应该都大写,并且指出完整含义. 参数的命名

修炼成高薪Java程序猿——从优秀的Java命名规范开始

优秀的Java命名规范 1命名规范 1.1 package (*) 包名全部由小写的ASCII字母组成,用"."分隔. 在此项目中,所有的包均以"com.prosten.ticket"开头. 1.2 class (*) 类名应当是名词,每个内部单词的头一个字母大写.应当使你的类名简单和具有说明性.用完整的英语单词或约定俗成的简写命名类名. [示例]public class UserManager 1.3 interface(*) 接口名应当是名词,每个内部单词的头一