再回首Java第四天

Javadoc
Javadoc工具只处理文档源文件在类,接口,方法,属性,构造器和内部类之前的注释,忽略其它地方的文档注释。而且Javadoc默认只处理以public或protected修饰的类,接口方法和属性、构造器之前的文档注释等文档。如果要处理private修饰的内容,在使用Javadoc工具是需要添加-private选项
常用Javadoc标记有如下一些:
@author:指定Java程序的作者
@versio:指定源文件的版本
@deprecated:不推荐使用的方法
@param:方法的参数的说明信息
@return:返回值的说明信息
@see: “参见”,用于指定交叉参考的内容
@exception:抛出异常的类型
@throws:抛出的异常与@exception
标记使用位置的限制
类或接口文档注释的有:@see @deprecated @author @deprecated
方法或构造器文档注释的有:@see @deprecated @param @return @throws @exception
属性文档注释的有:@see @deprecated

原文地址:https://www.cnblogs.com/Mrxiaolong/p/5331139.html