使用IDEA生成JavaDoc文档
JavaDoc是Sun公司提供的一种将注释生成HTML文档的技术,生成的HTML文档类似于Java的API。
标记 | 说明 | 标签类型 |
---|---|---|
@author 作者 | 作者标识 | 包、类、接口 |
@version 版本号 | 版本号 | 包、类、接口 |
@param 参数名 描述 | 方法的入参名及描述信息,如入参有特别要求,可在此注释。 | 构造函数、方法 |
@return 描述 | 对函数返回值的注释 | 方法 |
@deprecated 过期文本 | 标识随着程序版本的提升,当前API已经过期,仅为了保证兼容性依然存在.以此告之开发者不应再用这个API。 | 包、类、接口、值域、构造函数、方法 |
@throws 异常类名 | 构造函数或方法所会抛出的异常。 | 构造函数、方法 |
@exception 异常类名 | 同@throws | 构造函数、方法 |
@see 引用 | 查看相关内容,如类,方法,变量等。 | 包、类、接口、值域、构造函数、方法 |
@si |