javadoc使用

先把需要生成文档的类的路径重定向到一个清单文件：

find /home/aliang/JavaProject/demo/src/main/java/ -name *.java > target/sources-manifest.txt

生成文档(默认只会提取public和protected)：

javadoc -d target/apidocs -windowtitle demo @target/sources-manifest.txt

如果是内部使用，一般希望private修饰的也生成文档，并且把作者和版本给提出来：

javadoc -d target/apidocs-private -windowtitle demo -private -author -version @target/sources-manifest.txt

常用标记：

• @author：作者。
• @version：版本号。
• @see：参考类、方法或字段。如果是方法和字段，需要加#前缀，如"类名#方法名"。
• @deprecated：标记为不推荐，其实可以用@Deprecated注解来代替，不过这个标记可以用来详述不推荐的理由。
• @param：方法参数说明。
• @return：方法返回实例说明。
• @inheritDoc：继承父类或者接口的文档注释。