精华内容
下载资源
问答
  • JAVA 注释格式
    千次阅读
    2017-04-11 20:10:07

    1. 文件注释: (文件注释写入文件头部,包名之前的位置)

    说明: 注意以 /* 开始 避免补JavaDoc收集

    /*
     * 注释内容
     */
    package com.fsdn.msg;
    

    2. 文件注释内容: 版权说明、描述信息、生成日期、修改历史

    说明: 文件名可选

    /*
     * 文件名: [文件名]
     * 版权: <版权>
     * 描述: <描述>
     * 修改人: <修改人>
     * 修改时间: YYYY-MM-DD
     * 修改单号: <修改单号>
     * 修改内容: <修改内容>
     * /
    

    说明: 每次修改后在文件头部写明修改信息,CheckIn的时候可以直接把蓝色字体信息粘贴到VSS的注释上。在代码受控之前可以免去。

    示例:

    /*
     * 文件名: LogManager.java
     * 版权: Copyright 2002-2007 Huawei Tech. Co. Ltd. All Rights Reserved.
     * 描述: MMSC V100R002 Relay 通用日志系统
     * 修改人: 张三
     * 修改时间: 2017-02-01
     * 修改内容: 新增
     * 修改人: 李四
     * 修改时间: 2017-02-10
     * 修改单号: WSS368
     * 修改内容: xxx
     * /
    

    3. 类和接口的注释: 该注释放在package关键字之后,class或者interface关键字之前。

    说明: 方便JavaDoc收集

    package com.fsdn.msg;
    
    /**
     * <一句话功能简述>
     * <功能详细描述>
     * @author  [作者]
     * @version [版本号, YYYY-MM-DD]
     * @see     [相关类/方法]
     * @since   [产品/模块版本]
     * @deprecated
     */
    public class LogManager
    

    示例:

    package com.fsdn.msg;
    
    /**
     * LogManager 类集中控制对日志读写的操作
     * 全部为静态变量和静态方法,对外提供统一接口。
     * 分配对应日志类型的读写器,读取或写入符合条件的日志纪录。
     * @author  张三,李四,王五
     * @version 1.2, 2017-02-01
     * @see     LogIteraotor
     * @since   CommonLog 1.0
     */
    public class LogManager
    

    4. 类属性、公有和保护方法注释: 写在类属性、仅有和保护方法上面。

    格式:

    /**
     * <一句话功能简述>
     * <功能详细描述>
     * @param  [参数1] [参数1说明]
     * @param  [参数2] [参数2说明]
     * @return [返回类型说明]
     * @exception/throws [违例类型] [违例说明]
     * @see    [类、类#方法、类#成员]
     * @deprecated
     */
    

    示例:

    /**
     * 根据日志类型和时间读取日志
     * 分配对应日志类型的LogReader, 指定类型、查询时间段、条件和反复器缓冲数,读取日志记录。
     * 查询条件为null或0表示无限制,反复器缓冲数为0读不到日志查询时间为左包含原则,即 [startTime, endTime]
     * @param  logTypeName 日志类型名 (在配置文件中定义的)
     * @param startTime 查询日志的开始时间
     * @param endTime   查询日志的结束时间
     * @param logLevel  查询日志的级别
     * @param userName  查询该用户的日志
     * @param bufferNum 日志反复器缓冲记录数
     * @return 结果集, 日志反复器
     * @see    CommonLog 1.0
     */
    public static LogIterator read(String logType, Date startTime, Date endTime, int logLevel, String userName, int bufferNum)
    

    说明: 对于方法内部用throw语句抛出的异常, 必须在方法的注释中标明, 对于所调用的其他方法所抛出的异常,选择主要的在注释中说明。对于非RuntimeException,即throws子句声明会抛出的异常,必须在方法的注释中标明。

    注意:

    // 推荐使用
    @exception  // 标注 Runtime 异常
    
    @throws     // 标注非 Runtime 异常, 异常的注释必须说明该导演的含义及什么条件下抛出该异常
    
    更多相关内容
  • JAVA注释方法及格式

    千次阅读 2021-02-28 08:51:33
    JAVA注释方法及格式1、单行(single-line)--短注释://……单独行注释:在代码中单起一行注释, 注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。注释格式:/* 注释内容...

    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注释格式说明

    千次阅读 2014-08-18 16:18:16
     Java 的语法与 C++ 及为相似,那么,你知道 Java注释有几种吗?是两种?  // 注释一行  /* ...... */ 注释若干行  不完全对,除了以上两种之外,还有第三种,文档注释:  /** ...... */ 注释...

    前言

      Java 的语法与 C++ 及为相似,那么,你知道 Java 的注释有几种吗?是两种?

      // 注释一行
       /* ...... */ 注释若干行

      不完全对,除了以上两种之外,还有第三种,文档注释:

      /** ...... */ 注释若干行,并写入 javadoc 文档

      通常这种注释的多行写法如下:

      /**
       * .........
       * .........
       */

      暂停,暂停!这第三种注释有什么用?javadoc 又是什么东西?

      好,那就让我告诉你——


    一. Java 文档和 javadoc

      Java 程序员都应该知道使用 JDK 开发,最好的帮助信息就来自 SUN 发布的 Java 文档。它分包、分类详细的提供了各方法、属性的帮助信息,具有详细的类树信息、索引信息等,并提供了许多相关类之间的关系,如继承、实现接口、引用等。

      Java 文档全是由一些 html 文件组织起来的,在 SUM 的站点上可以下载它们的压缩包。但是你肯定想不到,这些文档我们可以自己生成。——就此打住,再吊一次胃口。

      安装了 JDK 之后,安装目录下有一个 src.jar 文件或者 src.zip 文件,它们都是以 ZIP 格式压缩的,可以使用 WinZip 解压。解压之后,我们就可以看到分目录放的全是 .java 文件。是了,这些就是 Java 运行类的源码了,非常完整,连注释都写得一清二楚……不过,怎么看这些注释都有点似曾相识的感觉?

      这就不奇怪了,我们的迷底也快要揭开了。如果你仔细对比一下 .java 源文件中的文档注释 (/** ... */) 和 Java 文档的内容,你会发现它们就是一样的。Java 文档只是还在格式和排版上下了些功夫。再仔细一点,你会发现 .java 源文件中的注释还带有 HTML 标识,如 <B>、<BR>、<Code> 等,在 Java 文档中,该出现这些标识的地方,已经按标识的的定义进行了排版。

      终于真像大白了,原来 Java 文档是来自这些注释。难怪这些注释叫做文档注释呢!不过,是什么工具把这些注释变成文档的呢?

      是该请出 javadoc 的时候了。在 JDK 的 bin 目录下你可以找到 javadoc,如果是 Windows 下的 JDK,它的文件名为 javadoc.exe。使用 javdoc 编译 .java 源文件时,它会读出 .java 源文件中的文档注释,并按照一定的规则与 Java 源程序一起进行编译,生成文档。

      介绍 javadoc 的编译命令之前,还是先了解一下文档注释的格式吧。不过为了能够编译下面提到的若干例子,这里先介绍一条 javadoc 命令:

      javadoc -d 文档存放目录 -author -version 源文件名.java

      这条命令编译一个名为 “源文件名.java”的 java 源文件,并将生成的文档存放在“文档存放目录”指定的目录下,生成的文档中 index.html 就是文档的首页。-author 和 -version 两个选项可以省略。


    二. 文档注释的格式

      文档注释可以用于对类、属性、方法等进行说明。写文档注释时除了需要使用 /** .... */ 限定之外,还需要注意注释内部的一些细节问题。

      1. 文档和文档注释的格式化

      生成的文档是 HTML 格式,而这些 HTML 格式的标识符并不是 javadoc 加的,而是我们在写注释的时候写上去的。比如,需要换行时,不是敲入一个回车符,而是写入 <br>,如果要分段,就应该在段前写入 <p>。

      因此,格式化文档,就是在文档注释中添加相应的 HTML 标识。

      文档注释的正文并不是直接复制到输出文件 (文档的 HTML 文件),而是读取每一行后,删掉前导的 * 号及 * 号以前的空格,再输入到文档的。如

      /**
    * This is first line. <br>
    ***** This is second line. <br>
    This is third line.
    */

      编译输出后的 HTML 源码则是

      This is first line. <br>
    This is second line. <br>
    This is third line.

      前导的 * 号允许连续使用多个,其效果和使用一个 * 号一样,但多个 * 号前不能有其它字符分隔,否则分隔符及后面的 * 号都将作为文档的内容。* 号在这里是作为左边界使用,如上例的第一行和第二行;如果没有前导的 * 号,则边界从第一个有效字符开始,而不包括前面的空格,如上例第三行。

      还有一点需要说明,文档注释只说明紧接其后的类、属性或者方法。如下例:

     
    /** comment for class */
    public class Test {
    
        /** comment for a attribute */
        int number;
    
        /** comment for a method */
        public void myMethod() { ...... }
    
        ......
    }

      上例中的三处注释就是分别对类、属性和方法的文档注释。它们生成的文档分别是说明紧接其后的类、属性、方法的。“紧接”二字尤其重要,如果忽略了这一点,就很可能造成生成的文档错误。如

     
    import java.lang.*;
    
    /** commnet for class */
    
    public class Test { ...... }
    
    // 此例为正确的例子

      这个文档注释将生成正确的文档。但只需要改变其中两行的位置,变成下例,就会出错:

     
    /** commnet for class */
    
    import java.lang.*;
    
    public class Test { ...... }
    
    // 此例为错误的例子

      这个例子只把上例的 import 语句和文档注释部分交换了位置,结果却大不相同——生成的文档中根本就找不到上述注释的内容了。原因何在?

      “/** commnet for class */”是对 class Test 的说明,把它放在“public class Test { ...... }”之前时,其后紧接着 class Test,符合规则,所以生成的文档正确。但是把它和“import java.lang.*;”调换了位置后,其后紧接的就是不 class Test 了,而是一个 import 语句。由于文档注释只能说明类、属性和方法,import 语句不在此列,所以这个文档注释就被当作错误说明省略掉了。

      2. 文档注释的三部分

      根据在文档中显示的效果,文档注释分为三部分。先举例如下,以便说明。

     
    /**
     * show 方法的简述.
     * <p>show 方法的详细说明第一行<br>
     * show 方法的详细说明第二行
     * @param b true 表示显示,false 表示隐藏
     * @return 没有返回值
     */
    public void show(boolean b) {
        frame.show(b);
    }

      第一部分是简述。文档中,对于属性和方法都是先有一个列表,然后才在后面一个一个的详细的说明。列表中属性名或者方法名后面那段说明就是简述。如下图中被红框框选的部分:

      简述部分写在一段文档注释的最前面,第一个点号 (.) 之前 (包括点号)。换句话说,就是用第一个点号分隔文档注释,之前是简述,之后是第二部分和第三部分。如上例中的 “* show 方法的简述.”。

      有时,即使正确地以一个点号作为分隔,javadoc 仍然会出错,把点号后面的部分也做为了第一部分。为了解决这个问题,我们可以使用一个 <p> 标志将第二分部分开为下一段,如上例的“* <p>show 方法的详细说明第一行 ....”。除此之外,我们也可以使用 <br> 来分隔。

      第二部分是详细说明部分。该部分对属性或者方法进行详细的说明,在格式上没有什么特殊的要求,可以包含若干个点号。它在文档中的位置如下图所示:

      这部分文档在上例中相应的代码是:

      * show 方法的简述.
       * <p>show 方法的详细说明第一行<br>
       * show 方法的详细说明第二行

      发现什么了?对了,简述也在其中。这一点要记住了,不要画蛇添足——在详细说明部分中再写一次简述哦!

      第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。它在文档中的位置:

      第三部分在上例中相应的代码是

      * @param b true 表示显示,false 表示隐藏
       * @return 没有返回值

      除了 @param 和 @return 之外,还有其它的一些特殊标记,分别用于对类、属性和方法的说明……不要推我,我马上就说。


    三. 使用 javadoc 标记

      javadoc 标记是插入文档注释中的特殊标记,它们用于标识代码中的特殊引用。javadoc 标记由“@”及其后所跟的标记类型和专用注释引用组成。记住了,三个部分——@、标记类型、专用注释引用。不过我宁愿把它分成两部分:@ 和标记类型、专用注释引用。虽然 @ 和 标记类型之间有时可以用空格符分隔,但是我宁愿始终将它们紧挨着写,以减少出错机会。

      javadoc 标记有如下一些:

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

      下面详细说明各标记。

      1. @see 的使用

      @see 的句法有三种:

      @see 类名
       @see #方法名或属性名
       @see 类名#方法名或属性名

      类名,可以根据需要只写出类名 (如 String) 或者写出类全名 (如 java.lang.String)。那么什么时候只需要写出类名,什么时候需要写出类全名呢?

      如果 java 源文件中的 import 语句包含了的类,可以只写出类名,如果没有包含,则需要写出类全名。java.lang 也已经默认被包含了。这和 javac 编译 java 源文件时的规定一样,所以可以简单的用 javac 编译来判断,源程序中 javac 能找到的类,javadoc 也一定能找到;javac 找不到的类,javadoc 也找不到,这就需要使用类全名了。

      方法名或者属性名,如果是属性名,则只需要写出属性名即可;如果是方法名,则需要写出方法名以及参数类型,没有参数的方法,需要写出一对括号。如

    成员类型 成员名称及参数 @see 句法
    属性 number @see number
    属性 count @see count
    方法 count() @see count()
    方法 show(boolean b) @see show(boolean)
    方法 main(String[] args) @see main(String[])

      有时也可以偷懒:假如上例中,没有 count 这一属性,那么参考方法 count() 就可以简写成 @see count。不过,为了安全起见,还是写全 @see count() 比较好。

      @see 的第二个句法和第三个句法都是转向方法或者属性的参考,它们有什么区别呢?

      第二个句法中没有指出类名,则默认为当前类。所以它定义的参考,都转向本类中的属性或者方法。而第三个句法中指出了类名,则还可以转向其它类的属性或者方法。

      关于 @see 标记,我们举个例说明。由于 @see 在对类说明、对属性说明、对方法说明时用法都一样,所以这里只以对类说明为例。

     
    /**
     * @see String
     * @see java.lang.StringBuffer
     * @see #str
     * @see #str()
     * @see #main(String[])
     * @see Object#toString()
     */
    public class TestJavaDoc {
    
    }

      生成的文档的相关部分如下图:

      String 和 StringBuffer 都是在 java.lang 包中,由于这个包是默认导入了的,所以这两个类可以直接写类名,也可以写类全名。str、str() 为同名属性和方法,所以方法名需要用 () 区分。main 是带参数的方法,所以在 () 中指明了参数类型。toString() 虽然在本类中也有 (从 Object 继承的),但我们是想参考 Object 类的 toString() 方法,所以使用了 Object#toString()。

      奇怪的是,为什么其中只有 str、str() 和 main(String[]) 变成了链接呢?那是因为编译时没有把 java.lang 包或者 Stirng、StringBuffer、Object 三个类的源文件一起加入编译,所以,生成的文档没有关于那三个类的信息,也就不可以建立链接了。后面讲解 javadoc 编译命令的时候还会详细说明。

      上例中如果去把类中的 str 属性去掉,那么生成的文档又会有什么变化呢?你会发现,原来是 str, str(),而现在变成了 str(), str(),因为 str 属性已经没有了,所以 str 也表示方法 str()。

      2. 使用 @author、@version 说明类

      这两个标记分别用于指明类的作者和版本。缺省情况下 javadoc 将其忽略,但命令行开关 -author 和 -version 可以修改这个功能,使其包含的信息被输出。这两个标记的句法如下:

      @author 作者名
       @version 版本号

      其中,@author 可以多次使用,以指明多个作者,生成的文档中每个作者之间使用逗号 (,) 隔开。@version 也可以使用多次,只有第一次有效,生成的文档中只会显示第一次使用 @version 指明的版本号。如下例

     
    /**
     * @author Fancy
     * @author Bird
     * @version Version 1.00
     * @version Version 2.00
     */
    public class TestJavaDoc {
    
    }

      生成文档的相关部分如图:

      从生成文档的图示中可以看出,两个 @author 语句都被编译,在文档中生成了作者列表。而两个 @version 语句中只有第一句被编译了,只生成了一个版本号。

      从图上看,作者列表是以逗号分隔的,如果我想分行显示怎么办?另外,如果我想显示两个以上的版本号又该怎么办?

      ——我们可以将上述两条 @author 语句合为一句,把两个 @version 语句也合为一句:

      @author Fancy<br>Bird
       @version Version 1.00<br>Version 2.00

      结果如图:

      我们这样做即达到了目的,又没有破坏规则。@author 之后的作者名和 @version 之后的版本号都可以是用户自己定义的任何 HTML 格式,所以我们可以使用 <br> 标记将其分行显示。同时,在一个 @version 中指明两个用 <br> 分隔的版本号,也没有破坏只显示第一个 @version 内容的规则。

      3. 使用 @param、@return 和 @exception 说明方法

      这三个标记都是只用于方法的。@param 描述方法的参数,@return 描述方法的返回值,@exception 描述方法可能抛出的异常。它们的句法如下:

      @param 参数名 参数说明
       @return 返回值说明
       @exception 异常类名 说明

      每一个 @param 只能描述方法的一个参数,所以,如果方法需要多个参数,就需要多次使用 @param 来描述。

      一个方法中只能用一个 @return,如果文档说明中列了多个 @return,则 javadoc 编译时会发出警告,且只有第一个 @return 在生成的文档中有效。

      方法可能抛出的异常应当用 @exception 描述。由于一个方法可能抛出多个异常,所以可以有多个 @exception。每个 @exception 后面应有简述的异常类名,说明中应指出抛出异常的原因。需要注意的是,异常类名应该根据源文件的 import 语句确定是写出类名还是类全名。   示例如下:

     
    public class TestJavaDoc {
    
        /**
         * @param n a switch
         * @param b excrescent parameter
         * @return true or false
         * @return excrescent return
         * @exception java.lang.Exception throw when switch is 1
         * @exception NullPointerException throw when parameter n is null
         */
        public boolean fun(Integer n) throws Exception {
            switch (n.intValue()) {
            case 0:
                break;
            case 1:
                throw new Exception("Test Only");
            default:
                return false;
            }
            return true;
        }
    
    }

      使用 javadoc 编译生成的文档相关部分如下图:

      可以看到,上例中 @param b excrescent parameter 一句是多余的,因为参数只是一个 n,并没有一个 b?5?是 javadoc 编译时并没有检查。因此,写文档注释时一定要正确匹配参数表与方法中正式参数表的项目。如果方法参数表中的参数是 a,文档中却给出对参数 x 的解释,或者再多出一个参数 i,就会让人摸不着头脑了。@exceptin 也是一样。

      上例程序中并没有抛出一个 NullPointerException,但是文档注释中为什么要写上这么一句呢,难道又是为了演示?这不是为了演示描述多余的异常也能通过编译,而是为了说明写异常说明时应考运行时 (RunTime) 异常的可能性。上例程序中,如果参数 n 是给的一个空值 (null),那么程序会在运行的时候抛出一个 NullPointerException,因此,在文档注释中添加了对 NullPointerException 的说明。

      上例中的 @return 语句有两个,但是根据规则,同一个方法中,只有第一个 @return 有效,其余的会被 javadoc 忽略。所以生成的文档中没有出现第二个 @return 的描述。

      讲到这里,该怎么写文档注释你应该已经清楚了,下面就开始讲解 javadoc 的常用命令。


    四. javadoc 命令

      运行 javadoc -help 可以看到 javadoc 的用法,这里列举常用参数如下:

    用法:
       javadoc [options] [packagenames] [sourcefiles]

    选项:

      -public 仅显示 public 类和成员
      -protected 显示 protected/public 类和成员 (缺省)
      -package 显示 package/protected/public 类和成员
      -private 显示所有类和成员
      -d <directory> 输出文件的目标目录
      -version 包含 @version 段
      -author 包含 @author 段
      -splitindex 将索引分为每个字母对应一个文件
      -windowtitle <text> 文档的浏览器窗口标题

      javadoc 编译文档时可以给定包列表,也可以给出源程序文件列表。例如在 CLASSPATH 下有两个包若干类如下:

      fancy.Editor
       fancy.Test
       fancy.editor.ECommand
       fancy.editor.EDocument
       fancy.editor.EView

      这里有两个包 (fancy 和 fancy.editor) 和 5 个类。那么编译时 (Windows 环境) 可以使用如下 javadoc 命令:

      javadoc fancy\Test.java fancy\Editor.java fancy\editor\ECommand.java fancy\editor\EDocument.java fancy\editor\EView.java

      这是给出 java 源文件作为编译参数的方法,注意命令中指出的是文件路径,应该根据实际情况改变。也可以是给出包名作为编译参数,如:

      javadoc fancy fancy.editor

      用浏览器打开生成文档的 index.html 文件即可发现两种方式编译结果的不同,如下图:

      用第二条命令生成的文档被框架分成了三部分:包列表、类列表和类说明。在包列表中选择了某个包之后,类列表中就会列出该包中的所有类;在类列表中选择了某个类之后,类说明部分就会显示出该类的详细文档。而用第一条命令生成的文档只有两部分,类列表和类说明,没有包列表。这就是两种方式生成文档的最大区别了。

      下面再来细说选项。

      -public、-protected、-package、-private 四个选项,只需要任选其一即可。它们指定的显示类成员的程度。它们显示的成员多少是一个包含的关系,如下表:

    -private (显示所有类和成员)
    -package (显示 package/protected/public 类和成员)
    -protected (显示 protected/public 类和成员)
    -public (仅显示 public 类和成员)

      -d 选项允许你定义输出目录。如果不用 -d 定义输出目录,生成的文档文件会放在当前目录下。-d 选项的用法是

      -d 目录名

      目录名为必填项,也就是说,如果你使用了 -d 参数,就一定要为它指定一个目录。这个目录必须已经存在了,如果还不存在,请在运行 javadoc 之前创建该目录。

      -version 和 -author 用于控制生成文档时是否生成 @version 和 @author 指定的内容。不加这两个参数的情况下,生成的文档中不包含版本和作者信息。

      -splitindex 选项将索引分为每个字母对应一个文件。默认情况下,索引文件只有一个,且该文件中包含所有索引内容。当然生成文档内容不多的时候,这样做非常合适,但是,如果文档内容非常多的时候,这个索引文件将包含非常多的内容,显得过于庞大。使用 -splitindex 会把索引文件按各索引项的第一个字母进行分类,每个字母对应一个文件。这样,就减轻了一个索引文件的负担。

      -windowtitle 选项为文档指定一个标题,该标题会显示在窗口的标题栏上。如果不指定该标题,而默认的文档标题为“生成的文档(无标题)”。该选项的用法是:

      -windowtitle 标题

      标题是一串没有包含空格的文本,因为空格符是用于分隔各参数的,所以不能包含空格。同 -d 类似,如果指定了 -windowtitle 选项,则必须指定标题文本。

      到此为止,Java 文档和 javadoc 就介绍完了。javadoc 真的能让我们在 Java 注释上做文章——生成开发文档。

    展开全文
  • 超级好用的 java 注释模板,吐血总结,整理。吐血总结,整理。
  • java注释规范文档

    2011-09-07 13:26:28
    java程序注释的规范,每个初学者都应该掌握规范进行编程开发和学习,习惯了规范,自然就会提升代码的质量,提升团队的开发进度!
  • 超经典的java代码注释格式化模版及配置说明。
  • IDEA java代码注释格式设置

    千次阅读 2019-06-16 10:50:34
    之前一直用的是Eclipse做开发,经常听别人说IDEA比Eclipse好用,当时觉得有Eclipse就够用,去用IDEA干啥,后来某一次使用IDEA之后,发现再也不想回到...java注释设置 1、点击file->Setting->Editor-&g...

         之前一直用的是Eclipse做开发,经常听别人说IDEA比Eclipse好用,当时觉得有Eclipse就够用,去用IDEA干啥,后来某一次使用IDEA之后,发现再也不想回到Eclipse,真香!

        现在将自己使用IDEA过程中的经验总结起来,分享给大家,并且也方便自己日后回溯和更新。

     java类注释设置

     1、点击file->Setting->Editor->File and Code Templates,选择Includes下的File Heade

     2、输入自定义的格式即可,如图:

               

             

    /**
    * 功能描述:
    * @Author: aaa
    * @Date: ${DATE} ${TIME}
    */

    展示效果:

     

     java方法头注释设置

    1、点击file->setting->Editor->Live Templates,

    2、新增一个模板,点击右边的 +,选择Template Group,

    3、选择创建好的模板,在点击+,选择Live Template。

    4、 按图进行配置,底部的提示如果是'No applicable contexts yet',点击define,勾选Java。

     

    **
    * 实现功能描述:
    * @param $param$
    * @return $retrun$
    */

    5、点击右边的Edit valiables,配置如下:

    6,最后点击ok保存生效。在使用时先写好方法和入参,在用快捷方式(输入/**点击Enter)生成方法注释即可。

    展开全文
  • 本篇文章主要介绍了IDEA添加Java注释模版的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
  • Java代码注释模板

    2017-09-18 16:10:22
    为便于规范各位开发人员代码、提高代码质量,研发中心需要启动代码评审...为了加快代码评审的速度,减少不必要的时间,可以加入一些代码评审的静态检查工具,另外需要为研发中心配置统一的编码模板和代码格式化模板。
  • java注释模板

    2014-05-11 09:54:25
    eclipse中java注释模板,有需要的朋友可以参考使用。
  • 清除Java代码注释

    2016-12-26 22:53:27
    1、使用MyEclipse清除注释 2、使用项目工程清除注释 3、简单方便操作 4、代码共享 ..
  • 这个是java文档注释模板,使用myeclipse创建的,里面添加了基本颜色,只需导进到开发工具就可以了
  • java代码注释规范文档

    2018-09-18 10:33:34
    后端开发技术的代码注释规范 单行注释 多行注释注释 文档注释 标签注释等等
  • java文件头注释格式

    2021-02-27 22:41:52
    myeclipse中java文件头注释格式设置2011-10-08 13:11:33| 分类: IDE|举报|字号订阅windows->preferences->java->Code Templates->comments->Type->edit Eclipse注释规范模版总结新建类文件/*** @...
  • 所有javadoc命令都只能出现于“/**”注释中。但和平常一样,注释结束于一个“*/”。主要通过两种方式来使用javADOc:嵌入的html,或使用“文档标记”。其中,“文档标记”(Doc tags)是一些以“@”开头的命令,置于...
  • java 注释模板

    2018-05-28 15:04:42
    java 注释模板 java 注释模板 java 注释模板 java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板
  • Java注释

    千次阅读 2021-02-28 16:01:29
    单行注释://多行注释/**/文档注释:/***文档注释用于从源代码自动生成文档执行javadoc*命名根据源代码中的内容生成网页*@XXX */不同格式注释可以嵌套。// Welcome1.java. Text-printing program...
  • java常用的三种注释方式

    千次阅读 2021-06-08 21:09:38
    1.在java中,有三种常用的标记注释方式,最常用的是单行注释,‘//’它由两条斜杆组成记住是斜杆而不是反斜杠(\),注释是用来给代码注释说明,会存放一些方便理解代码涵义的说明 2.如果需要写长篇内容注释且可用...
  • java 注释风格和java格式风格模版、简单好用
  • 编码规范(一)----JAVA注释规范

    万次阅读 多人点赞 2017-12-18 12:31:59
    好的代码规范是一个程序员的基本修炼,好的代码注释更能体现一个程序员的思维逻辑,虽然代码是用来给机器运行的,我们只要能写出能让编译器运行的代码就行了,但是如果没有好的编码规范,到项目后期,加入开发的人员...
  • Idea java代码格式注释设计

    千次阅读 2019-07-09 16:31:38
    Idea java代码格式注释设计文件格式化设置方法格式化设置 文件格式化设置 具体操作步骤如图所示,在class 之前加上我们需要的格式注释,比如我的配置如图所示: /** *@author FeianLing *@date ${DATE} */ ...
  • Window->Preference->Java->Code Style->Code Template -->code,点击右侧Import选择设置好的注释模板文件。
  • Java代码、注释模版格式文件
  • 问题:在使用shift+ctrl+F格式化代码的时候会出现以下的情况,注释也会格式化,把写在一行的注释分为两行显示,可读性不高而且格式不友好。这篇文章介绍了如何解决这个问题。
  • java源码注释翻译

    2015-06-15 11:04:45
    java源码注释翻译: 批量将源码文件夹下所有文件和子文件夹下类注释翻译为中文注释(调用百度翻译api接口), 欢迎大伙完善,评论!(在代码中成长!)。
  • IDEA注释模版(Java param括号、return全类名) 首先我们设置,创建Class文件生成类注释模版 一、File >> Settings… >> Editor >> File and Code Templates 找到 CSS File,并且在右边文本框中...
  • Java注释

    千次阅读 2021-03-06 20:19:56
    Java注释注释不是用来执行的,是用来给程序员看的。注释不会参与编译也不会参与运行。一共有3种注释:1.单行注释,通常对某一行代码进行解释说明语法:// 注释的内容2.多行注释,通常对某一段代码或者是某一个...
  • Java代码注释率检查器
  • java注释的三种形式

    千次阅读 2021-03-18 09:42:47
    JAVA注释共有三种形式:单行注释、多行注释、文档注释1.单行注释public class online{public static void main(String[] args) {//这是一个单行注释System.out.println("Hello World!");}}2.多行注释public class ...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 724,181
精华内容 289,672
关键字:

java注释的格式

java 订阅