首页 / JAVA / 如何为我们的程序编写开发文档——Java文档注释

如何为我们的程序编写开发文档——Java文档注释

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了如何为我们的程序编写开发文档——Java文档注释，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含1152字，纯文字阅读大概需要2分钟。

内容图文

Java文档注释是用于生成Java API文档的注释，通过在程序中的类、属性、方法部分加上注释，就可以用javadoc命令生成漂亮的API文档，是程序员进阶的必备技能。

注意，文档注释只说明紧跟其后的类、属性或者方法。
Javadoc文档生成命令为：

-author和-version可以省略。

根据在文档中显示的效果，文档注释分为三部分。举例如下：

第一部分是简述。如下图中被红框框选的部分:
如何为我们的程序编写开发文档——Java文档注释 - 文章图片
简述部分写在一段文档注释的最前面，第一个点号 (.) 之前 (包括点号).
第二部分是详细说明部分。该部分对属性或者方法进行详细的说明，雅思周末班在格式上没有什么特殊的要求，可以包含若干个点号。它在文档中的位置如下图所示：
如何为我们的程序编写开发文档——Java文档注释 - 文章图片
这部分文档对应的代码是：

第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。它在文档中的位置：
如何为我们的程序编写开发文档——Java文档注释 - 文章图片

标记范围作用
@author 类 标明开发该类的作者
@version 类 标明该类模块的版本
@see 类、属性、方法 参考转向，也就是相关主题
@param 方法 对方法中参数的说明
@return 方法 对方法返回值的说明
@exception 方法 对方法可能抛出的异常说明
     

除上面所写之外，还有javadoc命令等详细参数没有介绍，请自行在命令行中使用help命令查看。
关于生成Java文档，通过命令行进行生成通常只做演示的作用，我们开发所使用的IDE如：IntelliJ IDEA、Eclipse等均集成了文档生成功能，只需要我们把文档注释写好，然后点击按钮即可。

内容总结

以上是互联网集市为您收集整理的如何为我们的程序编写开发文档——Java文档注释全部内容，希望文章能够帮你解决如何为我们的程序编写开发文档——Java文档注释所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端

扫描二维码推送至手机访问。

本文链接：https://qyyshop.com/info/852269.html

来源：【匿名】