javadoc的用法

阅读更多

说到javadoc,可真是我们开发人员写文档的好东东.

1.关于注释

// 注释一行
/* ...... */ 注释若干行
/** ...... */ 注释若干行，可用来写 javadoc 文档
我常这么写:

引用内容

/**
 * .........
 * .........
 */

这中文档注释必须放在它要注释的类、字段或方法的前面，他们之间不能加别的语句。文档注释分为三个部分:
1)概述.一般在注释最前面
2)详细说明部分。一般以

开头，用以区分概述，换行用
。当然还可以加一些修辞的HTML标签，像,等。
3)特殊说明部分。@+指令+说明部分组成。
指令如下：
@author    对类的说明    标明开发该类模块的作者
@version    对类的说明    标明该类模块的版本
@see            对类、属性、方法的说明    参考转向，也就是相关主题
@param    对方法的说明    对方法中某参数的说明
@return    对方法的说明    对方法返回值的说明
@exception    对方法的说明    对方法可能抛出的异常进行说明

------------------------------------------------------------------------------------------------------
@author:
      @author 作者名     可用多次
@version :
      @version 版本号    只能用一次
@see:
      @see 类名
　　@see #方法名或属性名
　　@see 类名#方法名或属性名
@param：
      @param 参数名 参数说明    不会做检查
@return：
      @return 返回值说明   
@exception：
　　@exception 异常类名 说明    不会做检查


2.javadoc命令行



引用内容

javadoc [options] [packagenames] [sourcefiles]

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