zoukankan      html  css  js  c++  java
  • java之javadoc命令

    【javadoc命令的用法】
    1.java源文件里,注释以/**开始 并以*/结束,里面可以包含普通文件,HTML标记和javaDoc标记。这些将构成javaDoc文档。
    2.javadoc命令只能处理java源文件中在类声明,接口声明,成员方法声明,成员变量声明及构造方法声明之前的注释,忽略位于其它地方的注释。如 局部变量前的注释,即使符合规范也会被javadoc命令忽略。
    3.常见的javadoc标记
    @version 指定版本信息
    @since 指定最早出现在那个版本
    @author 指定作者
    @see 生成参考其它javaDoc文档的链接
    @link 生成参考其它javadoc文档的链接,它和@see标记的区别在于@link标记能够嵌入到注释语句中,为注释语句中的特定词汇生成链接。
    @deprecated 用来标明被注释的类,变量或方法已经不提倡使用,在将来的版本中可能被废弃。
    @param 描述方法的参数
    @return 描述方法的返回值
    @throws 描述方法抛出的异常,指明抛出异常的条件
    4.javadoc命令既可以处理包,也可以处理java源文件.
    javadoc [option] [packagenames] [sourcefiles]
    javadoc命令的主要选项:
    -public 仅为public访问级别的类及类的成员生成javaDoc文档
    -proteceted 仅为public和protected访问级别的类及类的成员生成javadoc文档.
    (默认选项)
    -package 仅为public,protected和默认访问级别的类及类的成员生成
    javaDoc文档
    -private 为public,protected,默认和private访问级别的类及类的成员生成javadoc文档
    -version 解析@version标记
    -author 解析@author标记
    -splitindex 将索引分为每个字母对应一个索引文件
    -sourcepath <pathlist> 指定java源文件的路径
    -classpath <pathlist> 指定classpath
    -d <directory> 指定javaDoc文档的输出目录
    javadoc命令的几个选项的用法:
    -public,-protected,-package和-private这4个选项用于指定输出那些访问级别的类和成员的javaDoc文档.其中protected为默认选项。
    -version和-author选项指定在javaDoc文档中包含由@version和@author标记指示的内容。这两个选项不是默认选项。在默认情况下,javadoc命令会忽略注释中的@version和@author标记,因此生成的javaDoc文档中不包含版本和作者信息。

  • 相关阅读:
    mysql 实战 or、in与union all 的查询效率
    转:手机流畅的决定性因素
    合批只是对CPU的优化,与GPU没有任何关系
    UNITY 打包时提示sdk tools 或 sdk build tools版本低时可以直接点update 按钮进行更新
    RGB ECT 4BIT 压缩后质量远高于RGB ETC2 4BIT
    Adreno GPU Profiler
    UNITY2018.3 在editor下运行时new memoryprofiler显示 shader占用内存很大的问题在安卓上并没有看到
    VS2017断点调试UNITY2018.3 经常卡住的问题
    一次UNITY闪退问题的定位心得
    UNITY2018 真机开启deepprofiling的操作
  • 原文地址:https://www.cnblogs.com/fjhh/p/5370642.html
Copyright © 2011-2022 走看看