javadoc工具目前还不能排除class里面的某些public method,在未来,如果方法的注释里面有@exclude或者@hide,javadoc工具能够识别,不会给这些方法生成文档。
经过测试,目前有两种可行的方法:
第一种方法:
1、下载javadoc.jar
2、方法注释中加入@exclude
/**
* @exclude
* @param userName 用户名
* @param passWord 口令
* @return
*/
public User getUser(String userName, String passWord)
3、eclipse->export->javadoc->use custom doclet(Doclet name:com.sun.tools.doclets.standard.Standard1;Doclet class path:存放位置\javadoc.jar)
->Extra Javadoc options(填入-encoding UTF-8 -d 文档输出位置\doc)
这样,javadoc文档就生成了,你会发现文档里没有getUser的说明,但是用默认的Use standard doclet是做不到的。
这种方法,生成的文档样式比较简陋,但是基本功能都有,而List<User>这种在文档里体现不出来,只能看到List。
如果希望文档样式好看,又能体现List<User>,就要采用第二种方法
第二种方法:
1、下载ydoc.jar
2、解压后yworks-uml-doclet-3.0_02-jdk1.5下面有doc、lib、resources三个目录
3、方法注释中加入@y.exclude
4、eclipse->export->javadoc->use custom doclet(Doclet name:ydoc.doclets.YStandard;Doclet class path:存放位置\yworks-uml-doclet-3.0_02-jdk1.5\lib\ydoc.jar)
->Extra Javadoc options填写:
-encoding UTF-8
-docletpath 存放位置\yworks-uml-doclet-3.0_02-jdk1.5\resources
-d 文档输出位置\doc
-filterpath 存放位置\yworks-uml-doclet-3.0_02-jdk1.5\lib\ydoc.jar
-filter ydoc.filters.ExcludeFilter
这种方法,生成的文档更好看一些,只是需要填入比较多的参数