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源⽂件.
java中split的用法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⽂档中不包含版本和作者信息。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。