• Javadoc注释的用法



    三. 使用 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 fancyTest.java fancyEditor.java fancyeditorECommand.java fancyeditorEDocument.java fancyeditorEView.java

    也可以是给出包名作为编译参数,如:javadoc fancy fancy.editor
    可以自己看看这两种方法的区别

    到此为止javadoc就简单介绍完了,想要用好她还是要多用,多参考标准java代码(可参考JDK安装目录下的src源文件包)

  • 相关阅读:
    网络编程基础
    面试题
    面试题合集
    异常
    三个重要的模块loggning,hashlib,configparse
    面向对象进阶
    单例模式
    反射
    封装
    开发规范
  • 原文地址:https://www.cnblogs.com/zhaolizhe/p/6945850.html
Copyright © 2020-2023  润新知