精华内容
下载资源
问答
  • javadoc注释规范

    万次阅读 2016-01-08 13:48:21
    java中的注释,大家应该已经很熟悉了。...生成的文档是 HTML 格式,而这些 HTML 格式的标识符并不是 javadoc 加的,而是我们在写注释的时候写上去的。比如,需要换行时,不是敲入一个回车符,而是写入 <b

    java中的注释,大家应该已经很熟悉了。

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

    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.   

      前导的 * 号允许连续使用多个,其效果和使用一个 * 号一样,但多个 * 号前不能有其它字符分隔,否则分隔符及后面的 * 号都将作为文档的内容。

     

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

    /** commnet forclass */  

    public classTest { ...... }


    2文档注释的三部分

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

     /**  

    * show 方法的简述. 

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

    * @param b true 表示显示,false 表示隐藏

    * @return 没有返回值

    */ 

    public voidshow(boolean b) { frame.show(b); }


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

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

     

    第二部分是详细说明部分。该部分对属性或者方法进行详细的说明,在格式上没有什么特殊的要求,可以包含若干个点号。 

     

    第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。第三部分在上例中相应的代码是:

    * @param b true 表示显示,false 表示隐藏  

    * @return 没有返回值 

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

    三. 使用 javadoc 标记

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

    javadoc 标记有如下一些:

    标记                            用于                                                        作用 

    @author           对类的说明                                          标明开发该类模块的作者  

    @version          对类的说明                                          标明该类模块的版本  

    @see                 对类、属性、方法的说明              参考转向,也就是相关主题  

    @param           对方法的说明                                     对方法中某参数的说明 

    @return                     对方法的说明                                     对方法返回值的说明 

    @exception     对方法的说明                                     对方法可能抛出的异常进行说明

    1 @see 的使用

    @see 的句法有三种: 

    @see 类名  

    @see #方法名或属性名

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

    例:

    /**  

    * @see     java.lang.String 

    * @see     #str 

    * @see     #str() 

    * @see  #main(String[]) 

    * @see     java.lang.Object#toString() 

    */  

    public classTestJavaDoc  {   

    private Stringstr; 

    public voidstr(){   }

    public staticvoid main(String[] args){   }

    }


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

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

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

    这两个标记的句法如下:   

    @author 作者名  

    @version 版本号   

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

    /**  

    * @author Fancy

    * @author Bird

    * @versionVersion 1.00

    * @versionVersion 2.00

    */ 

    public classTestJavaDoc {}


    生成文档的相关部分如图

    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 编译生成的文档相关部分如下图:

    四. 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 命令:

    javadocfancy\Test.java fancy\Editor.java fancy\editor\ECommand.java

    fancy\editor\EDocument.javafancy\editor\EView.java 

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

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

    千次阅读 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 注释上做文章——生成开发文档。

    展开全文
  • XML 实体引用、注释、命名规则

    千次阅读 2014-01-08 09:38:59
    实体引用在 XML 中,一些字符拥有特殊的意义。如果你把字符 "这样会产生 XML 错误:if salary 为了避免这个错误,请用实体引用来代替 "if salary..."引号注释:在 XML 中,只有字符 "XML 中的注释在 XML 中编写注释的语

    实体引用

    在 XML 中,一些字符拥有特殊的意义。

    如果你把字符 "<" 放在 XML 元素中,会发生错误,这是因为解析器会把它当作新元素的开始。

    这样会产生 XML 错误:

    <message>if salary < 1000 then</message>

    为了避免这个错误,请用实体引用来代替 "<" 字符:

    <message>if salary &lt; 1000 then</message> 

    在 XML 中,有 5 个预定义的实体引用:

    &lt; < 小于
    &gt; > 大于
    &amp; & 和号
    &apos; ' 单引号
    &quot; " 引号

    注释:在 XML 中,只有字符 "<" 和 "&" 确实是非法的。大于号是合法的,但是用实体引用来代替它是一个好习惯。

    XML 中的注释

    在 XML 中编写注释的语法与 HTML 的语法很相似:

    <!-- This is a comment --> 

    在 XML 中,空格会被保留

    HTML 会把多个连续的空格字符裁减(合并)为一个:

    HTML:	Hello           my name is David.
    输出:	Hello my name is David.
    

    在 XML 中,文档中的空格不会被删节。

    XML 命名规则

    XML 元素必须遵循以下命名规则:

    • 名称可以含字母、数字以及其他的字符
    • 名称不能以数字或者标点符号开始
    • 名称不能以字符 “xml”(或者 XML、Xml)开始
    • 名称不能包含空格

    可使用任何名称,没有保留的字词。

    最佳命名习惯

    使名称具有描述性。使用下划线的名称也很不错。

    名称应当比较简短,比如:<book_title>,而不是:<the_title_of_the_book>。

    避免 "-" 字符。如果您按照这样的方式进行命名:"first-name",一些软件会认为你需要提取第一个单词。

    避免 "." 字符。如果您按照这样的方式进行命名:"first.name",一些软件会认为 "name" 是对象 "first" 的属性。

    避免 ":" 字符。冒号会被转换为命名空间来使用(稍后介绍)。

    XML 文档经常有一个对应的数据库,其中的字段会对应 XML 文档中的元素。有一个实用的经验,即使用数据库的名称规则来命名 XML 文档中的元素。

    非英语的字母比如 éòá 也是合法的 XML 元素名,不过需要留意当软件开发商不支持这些字符时可能出现的问题。

    展开全文
  • Java 注释技巧

    千次阅读 2014-07-09 21:09:42
    在最初学习Android时候使用了Eclips IDE工具,编写java程序时,总是要添加一些注释,用以说明某段代码的作用,由于是从C过度来的,也没有太在意java的注释有何不同,将鼠标移动到Android sdk 提供的类、方法、属性上...

    Java 注释技巧

        在最初学习Android时候使用了Eclips IDE工具,编写java程序时,总是要添加一些注释,用以说明某段代码的作用,由于是从C过度来的,也没有太在意java的注释有何不同,将鼠标移动到Android sdk 提供的类、方法、属性上时总会有提示信息,而且弹出的提示信息就是代码注释,不同的是有一些特殊的符号,随着工程代码量的不断增加,文档注释的重要性日渐凸显,索性学习下Java的注释方法,让自己的代码变得更规范化一些。

    JavaDoc工具

        Java 有三种注释语句:
        1.//用于单行注释。  
        2./*...*/用于多行注释,从/*开始,到*/结束,不能嵌套。  
        3./**...*/则是为支持 jdk 工具 javadoc.exe 而特有的注释语句。


        当你在代码中填写好注释后,就可以使用JavaDoc工具提取程序中文档注释生成API文档,Javadoc 工具能从 java 源文件中读取第三种注释,并能识别注释中用@标识的一些特殊变量,制作成 Html 格式的类说明文档。javadoc 不但能对一个 java 源文件生成注释文档,而且能对目录和包生成交叉链接的 html 格式的类说明文档,十分方便。

        常用的Javadoc标记如下:
        @author         指定Java程序的作者
        @version        指定源文件版本
        @parameter      参数名及其意义
        @return         返回值
        @throws         异常类及抛出条件
        @deprecated     引起不推荐使用的警告(标识一个方法已经不推荐使用了)
        @see            “参见”,指定交叉参考的内容
        @since          表示从那个版本起开始有了这个函数
        @note           表示注解,暴露给源码阅读者的文档
        {@value}        当对常量进行注释时,如果想将其值包含在文档中,则通过该标签来引用常量的值。
        {@link包.类#成员} 链接到某个特定的成员对应的文档中。
       
        PS:只有/**...*/的注释语句中的内容才能被javadoc工具支持,所以javadoc的标记只能放在/**...*/注释中。

    Javadoc与html

        由于Javadoc生成的是html的样式,所以在文档注释中支持部分html的标签,下面是在使用文档注释常用的标签:

        段落级标签

        1)段落: <p>用于标记段落的开始,段落结束</p>
       
        2)换行: <br>
       
        3)<pre>预格式化标签:
        <pre>  </pre> 此标签用于显示预先已定义好格式的文本。当文本显示在浏览器中时,会遵循已在HTML源文档中定义的格式。

        文本格式化标签

        1)<b>标签
        <b>该文本将以粗体显示</b>
       
        2)<i>标签
        <i>该文本将以斜体显示</i>
       
        3)<sub>标签
        <sub>该文本的显示高度将低于前后的文本</sub>
       
        4)<sup>标签
        <sup>该文本的显示高度将高于周围的文本</sup>
       
        5)<blockquote>标签
        定义长的引用,<blockquote> </<blockquote>所包含的文字会被整体分离出来,让这段文字与周围文字形成对比,有缩进效果。

        5)<hr>
        <hr>用于定义水平分隔线
       

        列表标签

        <ul>  无序列表
        <ol>  有序列表
        <li>  列表项目的标签

        链接标签

        1)<a>  定义链接 href  指定链接地址
         <a href= "http://blog.csdn.net/jack_chen_00">博客地址</a>

    文档注释范例

    	
    /**
     * <a href= "<a target=_blank href="http://blog.csdn.net/jack_chen_00">http://blog.csdn.net/jack_chen_00</a>">博客地址</a>
     * @author Jack·chen 
     */
    public static class Person{
     
     /**男性,值为<a target=_blank href="mailto:{@value}*/">{@value}*/</a> 
     public static final int MALE = 1;
     /**女性,值为<a target=_blank href="mailto:{@value}*/">{@value}*/</a>
     public static final int FEMALE = 2;</p><p> /**
      * use to store person name 
      */
     protected String mName;
     /**
      * use to store second name of person
      * @see #mName
      */
     protected String mSecondName;
     
     /**/
     protected int mAge;</p><p> /**
      * Constructor that is called when inflating a view from XML. 
      * 
      * The class will be created after all children have been added.
      * added.
      * @version 1.0
      * @param mName name of person
      * @param mSndName  second name of person
      * @param mAge age of person
      */
     public Person(String mName,String mSndName, int mAge) {
      super();
      this.mName = mName;
      this.mSecondName = mSndName;
      this.mAge = mAge;
     }
     
     /**
      * <sup> Constructor </sup>that is called when inflating a view from XML.
         * 
      * <ul>
      * <li>The view receives a hover event with action <a target=_blank href="mailto:{@link">{@link</a> MotionEvent#ACTION_HOVER_ENTER}
      * when the pointer enters the bounds of the view.</li>
      * <li>The view receives a hover event with action <a target=_blank href="mailto:{@link">{@link</a> MotionEvent#ACTION_HOVER_MOVE}
      * when the pointer has already entered the bounds of the view and has moved.</li>
      * <li>The view receives a hover event with action <a target=_blank href="mailto:{@link">{@link</a> MotionEvent#ACTION_HOVER_EXIT}
      * when the pointer has exited the bounds of the view or when the pointer is
      * about to go down due to a button click, tap, or similar user action that
      * causes the view to be touched.</li>
      * </ul>
      * 
      * <pre> public boolean onGenericMotionEvent(MotionEvent event) {
         *     if ((event.getSource() &amp; InputDevice.SOURCE_CLASS_JOYSTICK) != 0) {
         *         if (event.getAction() == MotionEvent.ACTION_MOVE) {
         *             // process the joystick movement...
         *             return true;
         *         }
         *     }
         *     return super.onGenericMotionEvent(event);
         * }</pre>
         * 
      * <p>
      * The class will be created after all children have been added.
      * added.
      * @deprecated use <a target=_blank href="mailto:{@link">{@link</a> #Person(String,String,int)} instead
      * @version 1.0
      * @see Monkey
      * @param mName name of person
      * @param mAge age of person
      */
     public Person(String mName, int mAge) {
      super();
      this.mName = mName;
      this.mAge = mAge;
     }
     
    }
    

    Annotation

        从JDK 1.5开始,Java增加了对元数据(MeteData)的支持,也就是annotation(注释),这种Annotation与前面讲的注释有一定的却别,它是代码一种特殊的标记,这些标记可以在编译、类加载、运行时被读取,并执行相应的处理。通过Annotation,程序员可以在不更改源码的情况下嵌入一些补充信息,访问和处理Annotation的工具统称为APT(Annotation Processing Tool)。代码分析工具、开发工具可以利用这些补充信息进行验证,比如Eclips可以根据@Override检查复写方法的正确性。   

        标准的Annotation

        先看下Java提供的3个最基本的Annotation的用法:
        @Deprecated
        可作用于方法、类、接口等,它的作用于文档中注释中的@deprecated基本相同,是告诉编译器此方法、类等已经不建议使用了,以便在编程时给出警告。
       
        @Override
        只能作用于方法,用于指出该方法是重载父类的方法,它的作用是告诉编译器检查这个方法的语法是否正确,避免犯一些方法名称写错的低级错误。
       
        @SuppressWarnings
        用于消除编译器警告,在某些情况下编译警告是被允许或者合法,在这种情况下就可以使用@SuppressWarnings消除编译器警告
       
        如果你是用IDE工具Eclips开发Android 应用程序,你会发现上面提到的三个Annotation不需要手动添加,Eclips会自动提示你警告的原因以及解决办法,并自动帮你生成合适的Annotation补充信息,基本不需要程序员手动添加。
       

        自定义Annotation

        除了标准的Annotation,程序员还可以编写自定义的Annotation,自定义的Annotation可用于debug和编写一些测试程序。
        java中自定义annotation需要@interface关键字和用到几个内置annotation。用到的元注解有@Target, @Retention, @Documented, @Inherited ,用途如下:
        @Target 表示该注解用于什么地方,可能的 ElemenetType 参数包括:
            ElemenetType.CONSTRUCTOR 构造器声明
            ElemenetType.FIELD 域声明(包括 enum 实例)
            ElemenetType.LOCAL_VARIABLE 局部变量声明
            ElemenetType.METHOD 方法声明
            ElemenetType.PACKAGE 包声明
            ElemenetType.PARAMETER 参数声明
            ElemenetType.TYPE 类,接口(包括注解类型)或enum声明
            
        @Retention 表示在什么级别保存该注解信息。可选的 RetentionPolicy 参数包括:
            RetentionPolicy.SOURCE 注解将被编译器丢弃
            RetentionPolicy.CLASS 注解在class文件中可用,但会被VM丢弃
            RetentionPolicy.RUNTIME VM将在运行期也保留注释,因此可以通过反射机制读取注解的信息。
            
        @Documented 将此注解包含在 javadoc 中
        
        @Inherited 允许子类继承父类中的注解

       

    package javatest;
    
    import java.lang.annotation.Documented;
    import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    import java.lang.reflect.Method;
    import java.util.HashSet;
    import java.util.Set;
    
    public class JavaProject {  
    
    
    	@Target(ElementType.TYPE)
    	@Retention(RetentionPolicy.RUNTIME)
    	@Documented
    	public @interface Description {
    	    String value() default "no description";
    	}
    
    	@Target(ElementType.METHOD)
    	@Retention(RetentionPolicy.RUNTIME)
    	@Documented
    	public @interface Name {
    	    String originate();
    	    String community();
    	}
    
    	@Description("Mantis,Debug eye")
    	public static class JavaAnnotation {
    	    @Name(originate = "创始人:jack", community = "sunplus")
    	    public String getDebugProjectName() {
    	        return "Mantis";
    	    }
    	    @Name(originate = "创始人:清风道人", community = "suncompany")
    	    public String getStateName() {
    	        return "debuging";
    	    }
    	}
    
    
        public static void main(String[] args) {
    		Class test = JavaAnnotation.class;
            Method[] methods = test.getMethods();
            boolean flag = test.isAnnotationPresent(Description.class);
            if (flag) {
                Description des = (Description) test.getAnnotation(Description.class);
                System.out.println("描述:" + des.value());
                System.out.println("-----------------");
            }
            Set<Method> set = new HashSet<Method>();
            for (int i = 0; i < methods.length; i++) {
                boolean otherflag = methods[i].isAnnotationPresent(Name.class);
                if (otherflag) {
                    set.add(methods[i]);
                }
            }
            for (Method method : set) {
                Name name = method.getAnnotation(Name.class);
                System.out.println(name.originate());
                System.out.println("创建的社区:" + name.community());
            }
        }
    
    } 
    


     

    展开全文
  • Javascript 代码注释规范

    千次阅读 2017-05-10 12:17:07
    javascript 代码注释规范 注释一般来说是好事情,但新手编程经常犯错误。他们写注释解释“代码是什么”,但这样解释性注释应该越少越好。 严肃地说,好的代码应该容易理解无需注释。有个极好规则:如果代码不清楚...
  • C# 文档注释规范

    千次阅读 2015-12-04 16:05:10
    C# 文档注释规范 转http://www.cnblogs.com/cccc/archive/2009/08/19/1549866.html   C# 提供一种机制,使程序员可以使用含有 XML 文本的特殊注释语法为他们的代码编写文档。在源代码文件中,具有某种...
  • Java注释总结

    千次阅读 2014-07-01 21:26:53
    Java注释总结 一、开篇   在程序开发过程中,经常会遇到修改其他人代码的情况。这时候手里的代码会有这么几种情况: 有条理,通俗易懂;没有条理,通俗易懂;有条理,高深;没有条理,高深。   一般说来,...
  • Javadoc文档注释使用方法

    千次阅读 2015-04-22 09:27:17
    在Java里面主要有三种注释:行注释、段落注释、文档注释 这里主要说第三种:文档注释 文档注释是Java里面的一个比较厉害的功能,它可以用于注释类、属性、方法等说明,而且通过JDK工具javadoc直接生成相关文档, ...
  • Java 注释规范及快捷键

    千次阅读 2016-08-18 11:21:46
    1.1.0快捷键 a.调出你自己写好的默认注释: /** + ...说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。可以用注释统计工具来统计。   1.1
  • 这篇文章将介绍Go的编译运行、语法规范、注释转义及API标准库知识。这系列文章入门部分将参考“尚硅谷”韩顺平老师的视频和书籍《GO高级编程》,详见参考文献,并结合作者多年的编程经验进行学习和丰富,且看且珍惜...
  • 详细聊聊Javadoc注释规范

    万次阅读 2017-02-09 23:33:31
    Javadoc 注释规范 1. 注释分类2. Java文档和Javadoc3. 文档注释的格式  3.1 文档和文档注释的格式化3.2 文档注释的三部分 4. 使用Javadoc标记  4.1 @see 的使用4.2 @author、@version 说明类4.3 @param...
  • Java的注释说明

    千次阅读 2016-06-21 01:37:31
    在Java里面主要有三种注释:行注释、段落注释、文档注释  1)行注释:行注释也成为单行注释,行注释使用 “//注释文字”的格式来对某一行的代码进行注释或者加以说明 public class LineComment {  //这是单行...
  • Java 中的注释

    万次阅读 2018-08-26 16:26:12
    编写注释的原因 编写程序时总需要为程序添加一些注释,用以说明某段代码的作用,或者说明某个类的用途、某个方法的功能,以及该方法的参数和返回值的数据类型及意义等。 编写注释的原因及意义如下 1、为了更好的...
  • Java Annotation注释语法(元注释

    千次阅读 2011-12-01 17:19:10
    JAVA从J2SE5开始提供名为annotation(注释,标注)的功能。Java的annotation,可以附加在package, class, method, field等上面,相当于给它们添加了额外的辅助信息。附加在package, class, method, fiel
  • JAVA注释详解

    千次阅读 2007-12-13 12:02:00
    前言 Java 的语法与 C++ 及为相似,那么,你知道 Java 的注释有几种吗?是两种? // 注释一行 /* ...... */ 注释若干行 不完全对,除了以上两种之外,还有第三种,文档注释: /** ...... */ 注释若干行,并写入 ...
  • 正确的做法 一.强制文字不换行,并隐藏多余部分 CSS 代码 div{width:100px;overflow:hidden;white-space:nowrap;} td{width:100px;overflow:hidden;white-space:nowrap;word-break:keep-all;} HTML 代码...
  • 注释 向 Java 代码中添加元数据

    千次阅读 2007-08-24 11:30:00
    注释,J2SE 5.0 (Tiger) 中的新功能,将非常需要的元数据工具引入核心 Java 语言。该系列文章分为两部分,在这第 1 部分中,作者 Brett McLaughlin 解释了元数据如此有用的原因,向您介绍了 Java 语言中的注释,并...
  • 定义有无参数宏定义和带参数宏定义两种。...这种宏定义要求编译预处理程序将源程序中随后所有的定名的出现(注释与字符串常量中的除外)均用字符序列替换之。前面经常使用的定义符号常量是宏定义的最简单应用。如有:
  • 删除c++源文件的注释

    千次阅读 2011-06-09 17:52:00
    C++中的注释有两种风格:... 多行注释:以 /* 开始, */ 结束 几点特殊:(只在程序中试了一下,不保证完全正确啊)1. 双引号的注释不起作用2. 转义字符3. 没有嵌套注释 以下都是合法的注释://hello//hello /world/*
  • 如何对基因组序列进行注释

    万次阅读 多人点赞 2018-09-07 18:01:37
    基因组组装完成后,或者是完成了草图,就不可避免遇到一个问题,需要对基因组序列进行注释注释之前首先得构建基因模型,有三种策略: 从头注释(de novo prediction):通过已有的概率模型来预测基因结构,在预测...
  • JavaDOC注释使用方法

    千次阅读 2011-11-23 16:10:26
    Javadoc(转载) Posted on 2006-02-20 15:41 qiyadeng 阅读(330) 评论(0) 编辑 收藏 ... 文档注释的格式  1. 文档注释的格式化  2. 文档注释的三部分  三. 使用 javadoc 标记  1. @see 的使用
  • python注释google规范

    千次阅读 2019-04-19 11:47:39
    https://google.github.io/styleguide/pyguide.html https://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_language_rules/ http://legacy.python.org/dev/peps/pep-0008...
  • javadoc怎么提取java注释

    千次阅读 2012-12-10 15:28:24
     Java 的语法与 C++ 及为相似,那么,你知javadoc怎么提取java注释道 Java 的注释有几种吗?是两种?  // 注释一行  /* ...... */ 注释若干行  不完全对,除了以上两种之外,还有第三种,文档注释: ...
  • js里面的三种注释方法

    千次阅读 2014-04-07 12:40:00
    javascript(js)语言里面的注释方法有三种。 第一种是多行注释"/**/",一般js文件开头,介绍作者,函数等信息。 ...第二种注释方法是最常见的"...第三种注释不是很常见,会和html内...
  • Java中注释的规范&规则

    千次阅读 2019-07-08 11:02:24
    Java注释的三种方法,具体规则与规范,注释标识的使用以及如何提取Javadoc注释
  • Java&Android代码注释规范

    千次阅读 2015-05-19 17:18:02
    一、注释及简介 1、鄙人写的一些代码中,虽说有注释,但都是一些不符合规则的注释,即便拿出来查阅,也要花很一些时间才能搞懂程序的流程。为了良好的编程风格,我特意学习了java的文档注释,也分享给大家,良好的...
  • 正如你知道的,在Objective-C 和 Swift中写一条注释的最简单办法是用两条斜杠,如下图展示这样: 1 // This is a comment. 你可以(且必须)像上面那样来放置你的...
  • java中的注释规范,生成javadoc

    千次阅读 2016-09-23 15:54:04
    java中的注释,大家应该已经很熟悉了。 文档注释可以用于对类...生成的文档是 HTML 格式,而这些 HTML 格式的标识符并不是 javadoc 加的,而是我们在写注释的时候写上去的。比如,需要换行时,不是敲入一
  • JAVA 注释和嵌入式文档

    千次阅读 2012-01-09 13:25:28
    javadoc命令只能始于"/**",结束于"*/...Javadoc注释由Javadoc标签和描述性文本组成,你可以为类、接口添加注释,也可为构造函数、值域、方法等类中的元素添加注释。我们来看一个带Javadoc注释的程序,其代码如下所示:

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 127,626
精华内容 51,050
关键字:

下面定义html注释正确的是