1 / 4
文档名称:

javadoc注释规范.docx

格式:docx   大小:16KB   页数:4页
下载后只包含 1 个 DOCX 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

javadoc注释规范.docx

上传人:phl805 2019/3/2 文件大小:16 KB

下载得到文件列表

javadoc注释规范.docx

文档介绍

文档介绍:javadoc做注释  //注释一行 /*......*/注释若干行 /**......*/注释若干行,并写入javadoc文档 通常这种注释的多行写法如下: /** *......... *......... */ javadoc-d文档存放目录-author- 这条命令编译一个名为“”的java源文件,并将生成的文档存放在“文档存放目录”指定的目录下,。-author和-version两个选项可以省略。   生成的文档是HTML格式,而这些HTML格式的标识符并不是javadoc加的,而是我们在写注释的时候写上去的。 比如,需要换行时,不是敲入一个回车符,而是写入<br>,如果要分段,就应该在段前写入<p>。 文档注释的正文并不是直接复制到输出文件(文档的HTML文件),而是读取每一行后,删掉前导的*号及*号以前的空格,再输入到文档的。如 /** *Thisisfirstline.<br> *****Thisissecondline.<br> Thisisthirdline. */  先举例如下 /** *show方法的简述. *<p>show方法的详细说明第一行<br> *show方法的详细说明第二行 ****@parambtrue表示显示,false表示隐藏 ****@return没有返回值 */ publicvoidshow(booleanb){ (b); } 第一部分是简述。文档中,对于属性和方法都是先有一个列表,然后才在后面一个一个的详细的说明 简述部分写在一段文档注释的最前面,第一个点号(.)之前(包括点号)。换句话说,就是用第一个点号分隔文档注释,之前是简述,之后是第二部分和第三部分。 第二部分是详细说明部分。该部分对属性或者方法进行详细的说明,在格式上没有什么特殊的要求,可以包含若干个点号。 *show方法的简述. *<p>show方法的详细说明第一行<br> *show方法的详细说明第二行 简述也在其中。这一点要记住了 第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。 ****@parambtrue表示显示,false表示隐藏 ****@return没有返回值  javadoc标记由“@”及其后所跟的标记类型和专用注释引用组成 javadoc标记有如下一些: ***@author标明开发该类模块的作者 ***@version标明该类模块的版本 ***@see参考转向,也就是相关主题 ***@param对方法中某参数的说明 ***@return对方法返回值的说明 ***@exception对方法可能抛出的异常进行说明 ***@author作者名 ***@version版本号 其中,***@author可以多次使用,以指明多个作者,生成的文档中每个作者之间使用逗号(,)隔开。***@version也可以使用多次,只有第一次有效 使用***@param、***@return和***@exception说明方法 这三个标记都是只用于方法的。***@param描述方法的参数,***@return描述方法的返回值,***@exception描述方法可能抛出的异常。它们的句法如下: ***@param参数名参数说明 ***@retur