JavaDoc 生成文档

JavaDoc 生成文档

1 JavaDoc 作用

• javadoc 命令是用来生成自己的 API 文档的。

2 参数信息

/**
 * @author 作者名
 * @version 版本号
 * @since 指明需要最早使用的 JDK 版本
 * @param 参数名
 * @return 返回值情况
 * @throws 异常抛出情况
 */

3 注释

• 平时写代码，在代码比较少的时候，还可以看懂自己写的，但是当项目结构一旦复杂起来，就需要注释了。
• 注释并不会被执行，是给程序员看的。
• 书写注释是非常好的习惯，大公司都要求注释规范。
• 平时写代码就要注意注释规范。
• Java 中的注释有三种
  • 单行注释
  • 多行注释
  • 文档注释

4 JavaDoc 执行命令

$ javadoc -encoding UTF-8 -charset UTF-8 xxx.java

原文链接:https://www.cnblogs.com/yuehungege/p/studynotes_javadoc.html
如有疑问请与原作者联系

标签：

版权申明：本站文章部分自网络，如有侵权，请联系：west999com@outlook.com
特别注意：本站所有转载文章言论不代表本站观点，本站所提供的摄影照片，插画，设计作品，如需使用，请与原作者联系，版权归原作者所有