知识大全 javadoc生成注释(1)

Posted 2022-07-19 知

篇首语：亦余心之所善兮，虽九死其犹未悔。本文由小常识网(cha138.com)小编为大家整理，主要介绍了知识大全 javadoc生成注释(1)相关的知识，希望对你有一定的参考价值。

一 Java 文档　　 // 注释一行　　 /* */ 注释若干行　　 /** */ 注释若干行并写入 javadoc 文档　　通常这种注释的多行写法如下　　 /**　　 * 　　 * 　　 */　　javadoc d 文档存放目录 author version 源文件名 java　　这条命令编译一个名为源文件名 java 的 java 源文件并将生成的文档存放在文档存放目录指定的目录下生成的文档中 l 就是文档的首页 author 和 version 两个选项可以省略　　二文档注释的格式　　文档和文档注释的格式化　　生成的文档是 HTML 格式而这些 HTML 格式的标识符并不是 javadoc 加的而是我们在写注释的时候写上去的　　比如需要换行时不是敲入一个回车符而是写入 如果要分段就应该在段前写入 　　文档注释的正文并不是直接复制到输出文件 (文档的 HTML 文件) 而是读取每一行后删掉前导的 * 号及 * 号以前的空格再输入到文档的如　　 /**　　 * This is first line 　　 ***** This is second line 　　 This is third line 　　 */　　文档注释的三部分　　先举例如下　　 /**　　 * show 方法的简述　　 * show 方法的详细说明第一行 　　 * show 方法的详细说明第二行　　 * @param b true 表示显示 false 表示隐藏　　 * @return 没有返回值　　 */　　 public void show(boolean b) 　　 frame show(b);　　　　　　第一部分是简述文档中对于属性和方法都是先有一个列表然后才在后面一个一个的详细的说明　　简述部分写在一段文档注释的最前面第一个点号 ( ) 之前 (包括点号) 换句话说就是用第一个点号分隔文档注释之前是简述之后是第二部分和第三部分　　第二部分是详细说明部分该部分对属性或者方法进行详细的说明在格式上没有什么特殊的要求可以包含若干个点号　　 * show 方法的简述　　 * show 方法的详细说明第一行 　　 * show 方法的详细说明第二行　　简述也在其中这一点要记住了　　第三部分是特殊说明部分这部分包括版本说明参数说明返回值说明等　　 * @param b true 表示显示 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 Editor　　　　fancy Test　　　　fancy editor ECommand　　　　fancy editor EDocument　　　　fancy editor EView　　可以直接编译类　　 javadoc fancy\\Test java fancy\\Editor java fancy\\editor\\ECommand java fancy\\editor\\EDocument java fancy\\editor\\EView java　　也可以是给出包名作为编译参数如 javadoc fancy fancy editor　　可以自己看看这两种方法的区别　　到此为止javadoc就简单介绍完了想要用好她还是要多用多参考标准java代码　　Java代码规范　　注释　　　　 @author LEI　　　　 @version 　　注释文档的格式　　注释文档将用来生成HTML格式的代码报告所以注释文档必须书写在类域构造函数方法定义之前注释文档由两部分组成描述块标记　　例如　　 /**　　　　 * 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);　　　　　　　　前两行为描述描述完毕后由@符号起头为块标记注视

cha138/Article/program/Java/hx/201311/25889