c++ - Doxygen 自动参数生成

Question

是否有任何用于 Visual Studio C++ 的工具或插件来根据函数的定义生成 doxygen 注释的自动预结构？

谢谢你。

像这个例子：

/**
 *****************************************************************************************
 *  @brief      
 *
 *  @usage      
 * 
 *  @param      
 *  @param      
 *
 *  @return     
 ****************************************************************************************/

int TestAPI2(
    int argument1,
    int argument2
    );

Answer 1

我建议您使用参数内联文档

int TestAPI2(
    int argument1, /**< does this **/
    int argument2 /**< does that, should never be a prime number, 
                       and I keep wanting to go on and on about it. **/
    );

任何自动记录参数的工具都会产生其他人必须填写的无用文档。

WARN_NO_PARAMDOC = YES如果您想要一个尚未记录的参数列表，您可以在您的 doxygen 文件中进行设置。

也就是说，如果您有一些流程限制，其中无意义的评论比没有评论“更好” ，您可以尝试Gostdoc 。