当前位置: 首页 > 工具软件 > javadoc.chm > 使用案例 >

Javadoc简介

唐和洽
2023-12-01

老师让我们自学下Javadoc,特写此文以备交流和记忆

Javadoc

1. Javadoc 格式


采用格式如下:其中内容可以有多行,只要每个内容前都有符号*。
/**
* 内容
*/
当内容只有一行时,也可以写成/*内容/(不推荐)

其中内容开始于为@
例如:
/**
* @author 陈军正
*/

2. 常见的内容

  1. 作者
    格式:@author author-information
    使用场景:类
    例如:@author 陈军正
  2. 版本控制
    格式:@version version-information
    使用场景:类
    例如:@version 1.010
    3.参数说明
    格式:@param parameter-name description
    使用场景:方法和构造函数
    例如:@param code 物品的编号
    4.返回值说明、
    格式:@return description
    使用场景:方法
    例如:@return 物品的名称
    5.异常声明
    格式:@exception (or @throws) fully-qualified-class-name description
    使用场景:方法和构造函数
    例如:@exception IllegalArgumentException 除数为0时发生异常
    6.参考转向相关主题
    格式:@see 对应的内容
    使用场景:类,构造函数,方法,数据域
    例如:@see Milk

    3.Javadoc 命令


    javadoc [options] [packagenames] [sourcefiles]
    opinion:
    -public 仅显示 public 类和成员
    -protected 显示 protected/public 类和成员 (缺省)
    -package 显示 package/protected/public 类和成员
    -private 显示所有类和成员
    -d 输出文件的目标目录
    -version 包含 @version 段
    -author 包含 @author 段
    -splitindex 将索引分为每个字母对应一个文件
    -windowtitle 文档的浏览器窗口标题
    Packagenames:包名
    Sourcefiles:文件路径

 类似资料: