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. **/
    );

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

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

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