2019独角兽企业重金招聘Python工程师标准>>>

JAVA注释方法及格式

1、单行(single-line)--短注释：//……

单独行注释：在代码中单起一行注释， 注释前最好有一行空行，并与其后的代码具有一样的缩进层级。如果单行无法完成，则应采用块注释。注释格式：/* 注释内容 */行头注释：在代码行的开头进行注释。主要为了使该行代码失去意义。注释格式：// 注释内容行尾注释：尾端(trailing)--极短的注释，在代码行的行尾进行注释。一般与代码行后空8(至少4)个格，所有注释必须对齐。注释格式：代码 + 8(至少4)个空格 + // 注释内容

2、块(block)--块注释：/*……*/

注释若干行，通常用于提供文件、方法、数据结构等的意义与用途的说明，或者算法的描述。一般位于一个文件或者一个方法的前面，起到引导的作用，也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成：/*  * 注释内容  */

3、文档注释：/**……*/

注释若干行，并写入javadoc文档。每个文档注释都会被置于注释定界符/**......*/之中，注释文档将用来生成HTML格式的代码报告，所以注释文档必须书写在类、域、构造函数、方法，以及字段(field)定义之前。注释文档由两部分组成——描述、块标记。注释文档的格式如下： /*** The doGet method of the servlet. * This method is called when a form has its tag value method * equals to get.* @param request*  the request send by the client to the server* @param response*  the response send by the server to the client* @throws ServletException*  if an error occurred* @throws IOException*  if an error occurred*/

public void doGet (HttpServletRequest request, HttpServletResponse response)throws ServletException, IOException {    doPost(request, response);}

前两行为描述，描述完毕后，由@符号起头为块标记注释。更多有关文档注释和javadoc的详细资料，参见javadoc的主页： http://java.sun.com/javadoc/index.html

4、javadoc注释标签语法

@author    对类的说明 标明开发该类模块的作者 @version   对类的说明 标明该类模块的版本 @see      对类、属性、方法的说明 参考转向，也就是相关主题 @param    对方法的说明 对方法中某参数的说明 @return    对方法的说明 对方法返回值的说明 @exception  对方法的说明 对方法可能抛出的异常进行说明

JAVA注释具体实现

1、源文件注释

源文件注释采用 /** …… */，在每个源文件的头部要有必要的注释信息，包括：文件名；文件编号；版本号；作者；创建时间；文件描述包括本文件历史修改记录等。中文注释模版：/*** 文 件 名 : * CopyRright (c) 2008-xxxx:* 文件编号：* 创 建 人：* 日    期：* 修 改 人：* 日   期：* 描   述：* 版 本 号：*/

2、类(模块)注释：

类(模块)注释采用 /** ……*/，在每个类(模块)的头部要有必要的注释信息，包括：工程名；类(模块)编号；命名空间；类可以运行的JDK版本；版本号；作者；创建时间；类(模块)功能描述(如功能、主要算法、内部各部分之间的关系、该类与其类的关系等，必要时还要有一些如特别的软硬件要求等说明)；主要函数或过程清单及本类(模块)历史修改记录等。英文注释模版：/*** CopyRright (c)2008-xxxx:                             * Project:                                                               * Module ID:       * Comments:                                             * JDK version used:                                    * Namespace:                                         * Author：                         * Create Date：  * Modified By：                                            * Modified Date:                                      * Why & What is modified      * Version:                                         */如果模块只进行部分少量代码的修改时，则每次修改须添加以下注释：//Rewriter //Rewrite Date： Start1： /* 原代码内容*///End1： 将原代码内容注释掉，然后添加新代码使用以下注释：//Added by //Add date： Start2： //End2：如果模块输入输出参数或功能结构有较大修改，则每次修改必须添加以下注释：//Log ID：//Depiction：//Writer：修改者中文名//Rewrite Date：

2.1 接口注释：

接口注释采用 /** …… */，在满足类注释的基础之上，接口注释应该包含描述接口的目的、它应如何被使用以及如何不被使用，块标记部分必须注明作者和版本。在接口注释清楚的前提下对应的实现类可以不加注释。

3、构造函数注释：

构造函数注释采用 /** …… */，描述部分注明构造函数的作用，不一定有块标记部分。注释模版一：/*** 默认构造函数*/注释模版二：/*** Description :       带参数构造函数,*                       初始化模式名,名称和数据源类型* @param schema：   模式名* @param name：   名称* @param type： 数据源类型*/

4、函数注释：

函数注释采用 /** ……*/，在每个函数或者过程的前面要有必要的注释信息，包括：函数或过程名称；功能描述；输入、输出及返回值说明；调用关系及被调用关系说明等。函数注释里面可以不出现版本号(@version)。注释模版一：/**  * 函 数 名 :  * 功能描述：* 输入参数:     *             ** 返 回 值:  - 类型 *            * 异    常：* 创 建 人: * 日    期:* 修 改 人:* 日    期:*/注释模版二：/*** FunName:           getFirstSpell  * Description :      获取汉字拼音首字母的字符串，*                   被生成百家姓函数调用  * @param：         str the String是包含汉字的字符串  * @return String：汉字返回拼音首字母字符串；*                  英文字母返回对应的大写字母；*                 其他非简体汉字返回 '0'；* @Author:       ghc* @Create Date: 2008-07-02*/

5、方法注释：

方法注释采用 /** …… */，对于设置 (Set 方法 ) 与获取 (Get 方法 )成员的方法，在成员变量已有说明的情况下，可以不加注释；普通成员方法要求说明完成什么功能，参数含义是什么且返回值什么；另外方法的创建时间必须注释清楚，为将来的维护和阅读提供宝贵线索。

6、方法内部注释：

控制结构，代码做了些什么以及为什么这样做，处理顺序等，特别是复杂的逻辑处理部分，要尽可能的给出详细的注释。

7、全局变量注释：

要有较详细的注释，包括对其功能、取值范围、哪些函数或者过程存取以及存取时注意事项等的说明。

8、局部(中间)变量注释：

主要变量必须有注释，无特别意义的情况下可以不加注释。

9、实参/参数注释：

参数含义、及其它任何约束或前提条件。

10、字段/属性注释： 字段描述，属性说明。

11、常量：常量通常具有一定的实际意义，要定义相应说明。

转载于:https://my.oschina.net/u/2260184/blog/591582

代码要是没有注释，对读者来说就是一堆乱七八糟的字母，为了提高代码的可读性和可维护性，必须对代码进行必要的注释，这里小编整理了一下java注释规范。

(一)技巧

1：注释当前行快捷方式：ctrl+/

2：/* */  选上要注释的代码 ctrl+Shift+/

(二)在哪些地方加注释？

1：每个源文件开头都应有一组注释，包含代码的作者，时间；

2：当编写的代码较长，并且包含了多层嵌套时，花括号会比较多，比较乱，为了方便阅读，应该在某些段落结束的地方加注释，注明该闭合花括号对应的起点；

3：每个方法都必须加注释，对方法等进行注释时，注释最好放在代码上方，对变量声明进行注释时，注释最好放在行尾，但多行的行尾注释应该对齐；

4：典型算法必须有注释，代码有bug或不清楚的地方必须加注释，修改过的代码要加修改标志的注释。

(三)注释遵循哪些原则？

1：利用缩进和空行将注释与代码分隔开，是代码与注释在没有颜色提示情况下也能很容易分辨出来；

2：将注释内容与注释分隔符用一个空格隔开，便于查找注释；

3：对多行注释是尽量不用使用/*  * /，而是用多行“//”，可以避免查找配对的/*  */

(四)注释方法分类

1：单行注释-----//

单独行注释：

当注释需要单独单用一行时，使用“//” 并在注释前留一个空行，缩进情况要与下面的代码一致。一行放不下时使用多行，此时使用/*  */进行注释。

行尾注释：

在代码行的行尾加注释，一般要空8个格，且所有注释必须对齐。

2：块注释---/*内容*/

对若干行进行注释，一般放在方法之前，起引导作用，对方法和数据结构等的功能，意义进行说明

/*

*注释内容

*/

3：文档注释

注释若干行，将会形成HTML格式的代码报告，注释文档必须写在类，成员变量，成员方法，构造方法之前，例如下面是一个servlet创建后生成的一个注释文档

/**

* The doGet method of the servlet.

*

* This method is called when a form has its tag value method equals to get.

*

* @param request the request send by the client to the server

* @param response the response send by the server to the client

* @throws ServletException if an error occurred

* @throws IOException if an error occurred

*/

public void doGet(HttpServletRequest request, HttpServletResponse response)

throws ServletException, IOException {

doPost();

}

4：类注释

在myEclipse中，可以通过快捷键Alt+Shift+J生成，注释的内容可以通过Eclipse -> Window -> Preferences -> Java -> Code Style -> Code Templates -> Comments ->      Types -> Edt 设置

格式如下：

/**

* @author ASWH

*

* @Time 2014-3-30-17:33:01 */

类的英文注释模板

/**

* CopyRright (c)2014-xxxx:

* Project:

* Module ID:

* Comments:

* JDK version used:

* Namespace:

* Author：

* Create Date：

* Modified By：

* Modified Date:

* Why & What is modified

* Version:

*/

中文模板

/**

* 文 件 名 :

* CopyRright (c) 2014-xxxx:

* 文件编号：

* 创 建 人：

* 日 期：

* 修 改 人：

* 日 期：

* 描 述：

* 版 本 号：

*/

7：构造函数注释

/**

* 构造方法 的描述

* @param name

*

*/

8：方法注释

/**

* 生成随机数

*@param numble

随机数上限

*@return

*@exception (方法有异常的话加)

* @author ASWH

* @Time2014-3-30 17:35:29

*/

9：全局变量注释

/** The count is the number of charactersin the String. */

private int count;

有必要是要说明变量功能，涉及到的方法等等。

10：普通变量或常量

//属性

附录：javadoc参数说明：

@see 生成文档中的“参见xx 的条目”的超链接，后边可以加上：“类名”、“完整类名”、“完整类名#方法”。可用于：类、方法、变量注释。

@param 参数的说明。可用于：方法注释。

@return 返回值的说明。可用于：方法注释。

@exception 可能抛出异常的说明。可用于：方法注释。

@version 版本信息。可用于：类注释。

@author 作者名。可用于：类注释。

@deprecated 对类或方法的说明 该类或方法不建议使用,引起不推荐使用的警告

@note  表示注解，暴露给源码阅读者的文档

@remark 表示评论，暴露给客户程序员的文档

@since 表示从那个版本起开始有了这个函数

@see  表示交叉参考

版权声明：本文为博主原创文章，未经博主允许不得转载。