不要从原始源显示中删除 doxygen 标记注释

Question

如果我像这样在源代码中记录我的函数：

/// return random value between min and max
inline double random(double min, double max){
    return (double)rand() / (double)RAND_MAX * (max - min) + min;
}

然后 doxygen 删除原始源显示中的描述。例如，您可以在这里看到：

http://eigen.tuxfamily.org/dox/MatrixBase_8h_source.html

只要缺少行号，就会删除 doxygen 标记命令。有没有办法让他们留在里面？我认为这些 cmets 是有用的注释，即使在原始源显示中也可以保留...我找不到任何标志。

任何帮助表示赞赏！

Answer 1

对于这个 doxygen 有配置设置：STRIP_CODE_COMMENTS

将 STRIP_CODE_COMMENTS 标签设置为 YES 将指示 doxygen 从生成的源代码片段中隐藏任何特殊的注释块。 普通 C、C++ 和 Fortran cmets 将始终保持可见。这 默认值为：YES。

所以默认情况下 doxygen cmets 被剥离设置 STRIP_CODE_COMMENTS 到 NO 将保留 cmets。