javadoc的使用
2019-10-28 06:29:24来源：博客园 阅读 ()
javadoc的使用
在进行项目开发过程中，项目接口文档是很重要的一块内容，在java项目中我们可以用swagger，asciidoc，javadoc等方式来生产文档，而其中最基本的文档生成方式就是javadoc，它一般用在离线文档的生成上，我们需要按排它的规定来书写注释，从而最终生成文档。
标准化注释
- @link：{@link 包名.类名#方法名(参数类型)} 用于快速链接到相关代码
- @code： {@code text} 将文本标记为code
- @param：一般类中支持泛型时会通过@param来解释泛型的类型
- @author：作者信息
- @see ：另请参阅，其它备注
- @since ：从以下版本开始
- @version：当前版本号
- @param：后面跟参数名，再跟参数描述
- @return：返回值
- @throws ：跟异常类型 异常描述 , 用于描述方法内部可能抛出的异常跟返回值的描述
- @exception：用于描述方法签名throws对应的异常
- @see：既可以用来类上也可以用在方法上，表示可以参考的类或者方法
- @value：用于标注在常量上，{@value} 用于表示常量的值
- @inheritDoc：用于注解在重写方法或者子类上，用于继承父类中的Javadoc
生成doc文件
工具＝生成doc （tools=generate javaDocs...）
- 如果是中文注释，需要注意几点
- locale：设置成zh_CN
- other command line arguments 设置成-encoding UTF-8 -charset UTF-8
原文链接:https://www.cnblogs.com/lori/p/11747501.html
如有疑问请与原作者联系
标签：
版权申明：本站文章部分自网络，如有侵权，请联系：west999com@outlook.com
特别注意：本站所有转载文章言论不代表本站观点，本站所提供的摄影照片，插画，设计作品，如需使用，请与原作者联系，版权归原作者所有
- 聊聊 OAuth 2.0 的 token expire_in 使用 2020-06-08
- 为什么阿里巴巴Java开发手册中强制要求接口返回值不允许使用 2020-06-06
- 学习笔记之方法引用 2020-06-06
- idea使用小技巧（一） 2020-06-05
- 用斗地主的实例学会使用java Collections工具类 2020-06-05
IDC资讯： 主机资讯 注册资讯 托管资讯 vps资讯 网站建设
网站运营： 建站经验 策划盈利 搜索优化 网站推广 免费资源
网络编程： Asp.Net编程 Asp编程 Php编程 Xml编程 Access Mssql Mysql 其它
服务器技术： Web服务器 Ftp服务器 Mail服务器 Dns服务器 安全防护
软件技巧： 其它软件 Word Excel Powerpoint Ghost Vista QQ空间 QQ FlashGet 迅雷
网页制作： FrontPages Dreamweaver Javascript css photoshop fireworks Flash
