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

时间:2018-08-16 15:58:47

标签: doxygen

如果我在源代码中记录我的函数,如下所示:

/// 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标记命令。有没有办法让他们留在里面?我认为这些评论对于保留在原始源代码显示中也是很有帮助的。。。我对此没有找到任何标志。

任何帮助表示赞赏!

1 个答案:

答案 0 :(得分:2)

对于该doxygen,其配置设置为:STRIP_CODE_COMMENTS

  

将STRIP_CODE_COMMENTS标记设置为YES将指示doxygen   隐藏生成的源代码片段中的所有特殊注释块。   普通的C,C ++和Fortran注释将始终可见。的   默认值为:是。

因此,默认情况下,删除了Doxygen注释,将STRIP_CODE_COMMENTS设置为NO将保留注释。