《了解javadoc可识别的注释，提高代码文档化水平》 |21xrx.com

《了解javadoc可识别的注释，提高代码文档化水平》

2023-06-18 12:54:07 深夜i -- --

javadoc 注释 API文档

在编写代码的过程中，注释是必不可少的一部分。尤其是在团队协作和代码维护中，注释不仅可以帮助他人更好地理解代码，也可以帮助自己更好地回忆代码的作用和用法。但是，如何写出规范的注释，让javadoc可以识别生成API文档呢？

首先，javadoc可以识别的注释是以"/**"开头的注释，而非以"/*"或者"//"开头的注释。其次，javadoc支持的注释标签有很多，常用的包括@param、@return、@see、@throws等等。其中，@param标签后面跟参数名称和参数说明，@return标签后面跟返回值说明，@see标签后面跟需要引用的类或者方法名，@throws标签后面跟异常类型和异常说明。

下面是一个示例：


/**
* 计算两个数的和
* @param num1 第一个加数
* @param num2 第二个加数
* @return 两个数的和
* @throws IllegalArgumentException 如果其中一个参数为null，则抛出该异常
*/
public int add(Integer num1, Integer num2) throws IllegalArgumentException{
  if(num1 == null || num2 == null) {
    throw new IllegalArgumentException("参数不能为null");
  }
  return num1 + num2;
}

通过使用javadoc可识别的注释，并在build时使用javadoc命令，可以自动生成API文档供使用者查阅。在日常的开发过程中，我们应该养成良好的注释习惯，提高代码文档化水平，为代码的可维护性和可读性做出贡献。

上一篇: idea打包java可执行jar包

下一篇: Java与Pandas的数据分析比较

评论区

()

相似文章