javadoc注释范例 (20页)

javadoc注释 范例 企业形象设计范例幼儿园招生计划范例交接检查记录填写范例软件开发需求文档范例公路资料填写范例 javadoc注释范例篇一：JavaDOC注释使用方法JavaDOC注释使用方法目录前言一.Java文档和javadoc二.文档注释的格式1.文档注释的格式化2.文档注释的三部分三.使用javadoc标记1.@see的使用2.使用@author、@version说明类3.使用@param、@return和@exception说明方法四.javadoc命令前言Java的语法与C++及为相似，那么，你知道Java的注释有几种吗？是两种？//注释一行/*......*/注释若干行不完全对，除了以上两种之外，还有第三种，文档注释：/**......*/注释若干行，并写入javadoc文档通常这种注释的多行写法如下：/***.........*.........*/一.Java文档和javadocJava程序员都应该知道使用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文件)，而是读取每一行后，删掉前导的*号及*号以前的空格，再输入到文档的。如/***Thisisfirstline.<br>*****Thisissecondline.<br>Thisisthirdline.*/编译输出后的HTML源码则是Thisisfirstline.<br>Thisissecondline.<br>Thisisthirdline.前导的*号允许连续使用多个，其效果和使用一个*号一样，但多个*号前不能有其它字符分隔，否则分隔符及后面的*号都将作为文档的内容。*号在这里是作为左边界使用，如上例的第一行和第二行；如果没有前导的*号，则边界从第一个有效字符开始，而不包括前面的空格，如上例第三行。还有一点需要说明，文档注释只说明紧接其后的类、属性或者方法。如下例：/**commentforclass*/publicclassTest{/**commentforaattribute*/intnumber;/**commentforamethod*/publicvoidmyMethod(){......}......}上例中的三处注释就是分别对类、属性和方法的文档注释。它们生成的文档分别是说明紧接其后的类、属性、方法的。“紧接”二字尤其重要，如果忽略了这一点，就很可能造成生成的文档错误。如importjava.lang.*;/**commnetforclass*/publicclassTest{......}//此例为正确的例子这个文档注释将生成正确的文档。但只需要改变其中两行的位置，变成下例，就会出错：/**commnetforclass*/importjava.lang.*;publicclassTest{......}//此例为错误的例子这个例子只把上例的import语句和文档注释部分交换了位置，结果却大不相同——生成的文档中根本就找不到上述注释的内容了。原因何在？“/**commnetforclass*/”是对classTest的说明，把它放在“publicclassTest{......}”之前时，其后紧接着classTest，符合规则，所以生成的文档正确。但是把它和“importjava.lang.*;”调换了位置后，其后紧接的就是不classTest了，而是一个import语句。由于文档注释只能说明类、属性和方法，import语句不在此列，所以这个文档注释就被当作错误说明省略掉了。2.文档注释的三部分根据在文档中显示的效果，文档注释分为三部分。先举例如下，以便说明。/***show方法的简述.*<p>show方法的详细说明第一行<br>*show方法的详细说明第二行*@parambtrue 表 关于同志近三年现实表现材料材料类招标技术评分表图表与交易pdf视力表打印pdf用图表说话 pdf 示显示，false表示隐藏*@return没有返回值*/publicvoidshow(booleanb){frame.show(b);}第一部分是简述。文档中，对于属性和方法都是先有一个列表，然后才在后面一个一个的详细的说明。列表中属性名或者方法名后面那段说明就是简述。如下图中被红框框选的部分：简述部分写在一段文档注释的最前面，第一个点号(.)之前(包括点号)。换句话说，就是用第一个点号分隔文档注释，之前是简述，之后是第二部分和第三部分。如上例中的“*show方法的简述.”。有时，即使正确地以一个点号作为分隔，javadoc仍然会出错，把点号后面的部分也做为了第一部分。为了解决这个问题，我们可以使用一个<p>标志将第二分部分开为下一段，如上例的“*<p>show方法的详细说明第一行....”。除此之外，我们也可以使用<br>来分隔。第二部分是详细说明部分。该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号。它在文档中的位置如下图所示：这部分文档在上例中相应的代码是：*show方法的简述.*<p>show方法的详细说明第一行<br>*show方法的详细说明第二行发现什么了？对了，简述也在其中。这一点要记住了，不要画蛇添足——在详细说明部分中再写一次简述哦！篇二：javadoc注释规范javadoc注释规范javadoc做注释一.Java文档//注释一行/*......*/注释若干行/**......*/注释若干行，并写入javadoc文档通常这种注释的多行写法如下：/***.........*.........*/javadoc-d文档存放目录-author-version源文件名.java这条命令编译一个名为“源文件名.java”的java源文件，并将生成的文档存放在“文档存放目录”指定的目录下，生成的文档中index.html就是文档的首页。-author和-version两个选项可以省略。二.文档注释的格式1.文档和文档注释的格式化生成的文档是HTML格式，而这些HTML格式的标识符并不是javadoc加的，而是我们在写注释的时候写上去的。比如，需要换行时，不是敲入一个回车符，而是写入<br>，如果要分段，就应该在段前写入<p>。文档注释的正文并不是直接复制到输出文件(文档的HTML文件)，而是读取每一行后，删掉前导的*号及*号以前的空格，再输入到文档的。如/***Thisisfirstline.<br>*****Thisissecondline.<br>Thisisthirdline.*/2.文档注释的三部分先举例如下/***show方法的简述.*<p>show方法的详细说明第一行<br>*show方法的详细说明第二行*@parambtrue表示显示，false表示隐藏*@return没有返回值*/publicvoidshow(booleanb){frame.show(b);}第一部分是简述。文档中，对于属性和方法都是先有一个列表，然后才在后面一个一个的详细的说明简述部分写在一段文档注释的最前面，第一个点号(.)之前(包括点号)。换句话说，就是用第一个点号分隔文档注释，之前是简述，之后是第二部分和第三部分。第二部分是详细说明部分。该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号。*show方法的简述.*<p>show方法的详细说明第一行<br>*show方法的详细说明第二行简述也在其中。这一点要记住了第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。*@parambtrue表示显示，false表示隐藏*@return没有返回值三.使用javadoc标记javadoc标记由“@”及其后所跟的标记类型和专用注释引用组成javadoc标记有如下一些：@author标明开发该类模块的作者@version标明该类模块的版本@see参考转向，也就是相关主题@param对方法中某参数的说明@return对方法返回值的说明@exception对方法可能抛出的异常进行说明@author作者名@version版本号其中，@author可以多次使用，以指明多个作者，生成的文档中每个作者之间使用逗号(,)隔开。@version也可以使用多次，只有第一次有效使用@param、@return和@exception说明方法这三个标记都是只用于方法的。@param描述方法的参数，@return描述方法的返回值，@exception描述方法可能抛出的异常。它们的句法如下：@param参数名参数说明@return返回值说明@exception异常类名说明四.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.Editorfancy.Testfancy.editor.ECommandfancy.editor.EDocumentfancy.editor.EView可以直接编译类：javadocfancy\Test.javafancy\Editor.javafancy\editor\ECommand.javafancy\editor\EDocument.javafancy\editor\EView.java也可以是给出包名作为编译参数，如：javadocfancyfancy.editor可以自己看看这两种方法的区别到此为止javadoc就简单介绍完了，想要用好她还是要多用，多参考标准java代码Java代码规范--注释@authorLEI@version1.102005-09-011注释文档的格式注释文档将用来生成HTML格式的代码 报告 软件系统测试报告下载sgs报告如何下载关于路面塌陷情况报告535n,sgs报告怎么下载竣工报告下载 ，所以注释文档必须书写在类、域、构造函数、方法、定义之前。注释文档由两部分组成——描述、块标记。例如：/***ThedoGetmethodoftheservlet.*Thismethodiscalledwhenaformhasitstagvaluemethodequalstoget.**@paramrequest*therequestsendbytheclienttotheserver*@paramresponse*theresponsesendbytheservertotheclient*@throwsServletException*ifanerroroccurred*@throwsIOException*ifanerroroccurred*/publicvoiddoGet(HttpServletRequestrequest,HttpServletResponseresponse)throwsServletException,IOException{doPost(request,response);}前两行为描述，描述完毕后，由@符号起头为块标记注视。2注释的种类2.1文件头注释文件头注释以/*开始，以*/结束，需要注明该文件创建时间，文件名，命名空间信息。例如：/**Createdon2005-7-2*/2.2类、接口注释类、接口的注释采用/**?*/，描述部分用来书写该类的作用或者相关信息，块标记部分必须注明作者和版本。例如：/**Title:XXXXDRIVER3.0*Description:XXXXDRIVER3.0*Copyright:Copyright(c)2003*Company:XXXX有限公司**@authorJava(来自:WWw.:javadoc注释范例)DevelopmentGroup*@version3.0*/例如：/***Aclassrepresentingawindowonthescreen.*Forexample:**Windowwin=newWindow(parent);*win.show();***@authorSamiShaio*@version%I%,%G%篇三：javadoc注释规范javadoc做注释一.Java文档//注释一行/*......*/注释若干行/**......*/注释若干行，并写入javadoc文档通常这种注释的多行写法如下：/***.........*.........*/javadoc-d文档存放目录-author-version源文件名.java这条命令编译一个名为“源文件名.java”的java源文件，并将生成的文档存放在“文档存放目录”指定的目录下，生成的文档中index.html就是文档的首页。-author和-version两个选项可以省略。二.文档注释的格式1.文档和文档注释的格式化生成的文档是HTML格式，而这些HTML格式的标识符并不是javadoc加的，而是我们在写注释的时候写上去的。比如，需要换行时，不是敲入一个回车符，而是写入<br>，如果要分段，就应该在段前写入<p>。文档注释的正文并不是直接复制到输出文件(文档的HTML文件)，而是读取每一行后，删掉前导的*号及*号以前的空格，再输入到文档的。如/***Thisisfirstline.<br>*****Thisissecondline.<br>Thisisthirdline.*/2.文档注释的三部分先举例如下/***show方法的简述.*<p>show方法的详细说明第一行<br>*show方法的详细说明第二行*@parambtrue表示显示，false表示隐藏*@return没有返回值*/publicvoidshow(booleanb){frame.show(b);}第一部分是简述。文档中，对于属性和方法都是先有一个列表，然后才在后面一个一个的详细的说明简述部分写在一段文档注释的最前面，第一个点号(.)之前(包括点号)。换句话说，就是用第一个点号分隔文档注释，之前是简述，之后是第二部分和第三部分。第二部分是详细说明部分。该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号。*show方法的简述.*<p>show方法的详细说明第一行<br>*show方法的详细说明第二行简述也在其中。这一点要记住了第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。*@parambtrue表示显示，false表示隐藏*@return没有返回值三.使用javadoc标记javadoc标记由“@”及其后所跟的标记类型和专用注释引用组成javadoc标记有如下一些：@author标明开发该类模块的作者@version标明该类模块的版本@see参考转向，也就是相关主题@param对方法中某参数的说明@return对方法返回值的说明@exception对方法可能抛出的异常进行说明@author作者名@version版本号其中，@author可以多次使用，以指明多个作者，生成的文档中每个作者之间使用逗号(,)隔开。@version也可以使用多次，只有第一次有效使用@param、@return和@exception说明方法这三个标记都是只用于方法的。@param描述方法的参数，@return描述方法的返回值，@exception描述方法可能抛出的异常。它们的句法如下：@param参数名参数说明@return返回值说明@exception异常类名说明四.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.Editorfancy.Testfancy.editor.ECommandfancy.editor.EDocumentfancy.editor.EView可以直接编译类：javadocfancy\Test.javafancy\Editor.javafancy\editor\ECommand.javafancy\editor\EDocument.javafancy\editor\EView.java也可以是给出包名作为编译参数，如：javadocfancyfancy.editor可以自己看看这两种方法的区别到此为止javadoc就简单介绍完了，想要用好她还是要多用，多参考标准java代码Java代码规范--注释@authorLEI@version1.102005-09-011注释文档的格式注释文档将用来生成HTML格式的代码报告，所以注释文档必须书写在类、域、构造函数、方法、定义之前。注释文档由两部分组成——描述、块标记。例如：/***ThedoGetmethodoftheservlet.*Thismethodiscalledwhenaformhasitstagvaluemethodequalstoget.**@paramrequest*therequestsendbytheclienttotheserver*@paramresponse*theresponsesendbytheservertotheclient*@throwsServletException*ifanerroroccurred*@throwsIOException*ifanerroroccurred*/publicvoiddoGet(HttpServletRequestrequest,HttpServletResponseresponse)throwsServletException,IOException{doPost(request,response);}前两行为描述，描述完毕后，由@符号起头为块标记注视。2注释的种类2.1文件头注释文件头注释以/*开始，以*/结束，需要注明该文件创建时间，文件名，命名空间信息。例如：/**Createdon2005-7-2*/2.2类、接口注释类、接口的注释采用/**…*/，描述部分用来书写该类的作用或者相关信息，块标记部分必须注明作者和版本。例如：/**Title:XXXXDRIVER3.0*Description:XXXXDRIVER3.0*Copyright:Copyright(c)2003*Company:XXXX有限公司**@authorJavaDevelopmentGroup*@version3.0*/例如：/***Aclassrepresentingawindowonthescreen.*Forexample:**Windowwin=newWindow(parent);*win.show();***@authorSamiShaio*@version%I%,%G%*@seejava.awt.BaseWindow*@seejava.awt.Button*/classWindowextendsBaseWindow{...篇四：javadoc注释规范JAVADOC的注释规范对于Java注释共有三种：1.2.3.//注释一行/*......*/注释若干行/**......*/注释若干行，并写入javadoc文档通常这种注释的多行写法如下：/***.........*.........*/一.Java文档和JavadocJava程序员都应该知道使用JDK开发，最好的帮助信息就来自SUN发布的Java文档。它分包、分类详细的提供了各方法、属性的帮助信息，具有详细的类树信息、索引信息等，并提供了许多相关类之间的关系，如继承、实现接口、引用等。Java文档全是由一些html文件组织起来的，在SUM的站点上可以下载它们的压缩包。但是你肯定想不到，这些文档我们可以自己生成。安装了JDK之后，安装目录下有一个src.jar文件或者src.zip文件，它们都是以ZIP格式压缩的，可以使用WinZip解压。解压之后，我们就可以看到分目录放的全是.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-d文档存放目录-author-version源文件名.java这条命令编译一个名为“源文件名.java”的java源文件，并将生成的文档存放在“文档存放目录”指定的目录下，生成的文档中index.html就是文档的首页。-author和-version两上选项可选。二.文档注释的格式文档注释可以用于对类、属性、方法等进行说明。写文档注释时除了需要使用/**....*/限定之外，还需要注意注释内部的一些细节问题。1.文档和文档注释的格式化生成的文档是HTML格式，而这些HTML格式的标识符并不是javadoc加的，而是我们在写注释的时候写上去的。比如，需要换行时，不是敲入一个回车符，而是写入＜br＞，如果要分段，就应该在段前写入＜p＞。因此，格式化文档，就是在文档注释中添加相应的HTML标识。文档注释的正文并不是直接复制到输出文件(文档的HTML文件)，而是读取每一行后，删掉前导的*号及*号以前的空格，再输入到文档的。如编译输出后的HTML源码则是前导的*号允许连续使用多个，其效果和使用一个*号一样，但多个*号前不能有其它字符分隔，否则分隔符及后面的*号都将作为文档的内容。还有一点需要说明，文档注释只说明紧接其后的类、属性或者方法。如下例：上例中的三处注释就是分别对类、属性和方法的文档注释。它们生成的文档分别是说明紧接其后的类、属性、方法的。“紧接”二字尤其重要，如果忽略了这一点，就很可能造成生成的文档错误。如这个文档注释将生成正确的文档。但只需要改变其中两行的位置，变成下例，就会出错：这个例子只把上例的import语句和文档注释部分交换了位置，结果却大不相同——生成的文档中根本就找不到上述注释的内容了。原因何在？“/**commnetforclass*/”是对classTest的说明，把它放在“publicclassTest{......}”之前时，其后紧接着classTest，符合规则，所以生成的文档正确。但是把它和“importjava.lang.*;”调换了位置后，其后紧接的就是不classTest了，而是一个import语句。由于文档注释只能说明类、属性和方法，import语句不在此列，所以这个文档注释就被当作错误说明省略掉了。2.文档注释的三部分根据在文档中显示的效果，文档注释分为三部分。先举例如下，以便说明。第一部分是简述，列表中属性名或者方法名后面那段说明就是简述。简述部分写在一段文档注释的最前面，第一个点号(.)之前(包括点号)。换句话说，就是用第一个点号分隔文档注释，之前是简述，之后是第二部分和第三部分。如上例中的“*show方法的简述.”。有时，即使正确地以一个点号作为分隔，javadoc仍然会出错，把点号后面的部分也做为了第一部分。为了解决这个问题，我们可以使用一个＜p＞标志将第二分部分分开，如上例的“*＜p＞show方法的详细说明第一行....”。第二部分是详细说明部分。该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号。第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。第三部分在上例中相应的代码是：除了@param和@return之外，还有其它的一些特殊标记，分别用于对类、属性和方法的说明。三.使用javadoc标记javadoc标记是插入文档注释中的特殊标记，它们用于标识代码中的特殊引用。javadoc标记由“@”及其后所跟的标记类型和专用注释引用组成。记住了，三个部分——@、标记类型、专用注释引用。虽然@和标记类型之间有时可以用空格符分隔，但是推荐将它们紧挨着写，以减少出错机会。javadoc标记有如下一些：下面详细说明各标记。1.@see的使用@see的句法有三种：类名，可以根据需要只写出类名(如String)或者写出类全名(如java.lang.String)。那么什么时候只需要写出类名，什么时候需要写出类全名呢？如果java源文件中的import语句包含了的类，可以只写出类名，如果没有包含，则需要写出类全名。java.lang也已经默认被包含了。这和javac编译java源文件时的规定一样，所以可以简单的用javac编译来判断，源程序中javac能找到的类，javadoc也一定能找到；javac找不到的类，javadoc也找不到，这就需要使用类全名了。方法名或者属性名，如果是属性名，则只需要写出属性名即可；如果是方法名，则需要写出方法名以及参数类型，没有参数的方法，需要写出一对括号。如有时也可以偷懒：假如上例中，没有count这一属性，那么参考方法count()就可以简写成@seecount。不过，为了安全起见，还是写全@seecount()比较好。@see的第二个句法和第三个句法都是转向方法或者属性的参考，它们有什么区别呢？第二个句法中没有指出类名，则默认为当前类。所以它定义的参考，都转向本类中的属性或者方法。而第三个句法中指出了类名，则还可以转向其它类的属性或者方法。关于@see标记，我们举个例说明。由于@see在对类说明、对属性说明、对方法说明时用法都一样，所以这里只以对类说明为例。