Doxygen和JavaDoc注释风格（函数头部描述）（没看出有啥区别）

Posted 2023-03-08 Dontla

文章目录

• • Doxygen注释风格
  • JavaDoc注释风格

Doxygen和JavaDoc是两种常见的文档注释风格，它们用于为C++和Java程序提供自动生成文档的支持。

Doxygen注释风格

Doxygen是一种用于C++、C、Java等语言的文档注释工具，它可以根据代码中的注释自动生成文档。Doxygen使用C++风格的注释，即使用“/**”和“*/”来包含注释内容。
Doxygen注释风格的特点是注释内容中包含特定的标签，例如@param和@return，以便自动化工具能够识别注释中的信息并生成文档。

例如，以下是使用Doxygen风格注释的C++函数：

/**
 * @brief 函数描述
 *
 * @param arg1 参数1的描述
 * @param arg2 参数2的描述
 * @return 返回值的描述
 */
int myFunction(int arg1, float arg2) 
    // 函数体

JavaDoc注释风格

JavaDoc是一种用于Java语言的文档注释风格，它也可以根据代码中的注释自动生成文档。JavaDoc使用类似于Doxygen的注释格式，即使用“/**”和“*/”来包含注释内容。
JavaDoc注释风格的特点是注释内容中包含特定的标签，例如@param和@return，以便自动化工具能够识别注释中的信息并生成文档。

例如，以下是使用JavaDoc风格注释的Java函数：

/**
 * 函数描述
 *
 * @param arg1 参数1的描述
 * @param arg2 参数2的描述
 * @return 返回值的描述
 */
public int myFunction(int arg1, float arg2) 
    // 函数体

看来看去，也没看出有啥区别啊？？？