不要从原始源显示中删除 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 标记命令就会被删除。有没有办法让他们留在里面？我认为这些评论是有用的评论，即使在原始源代码显示中也能保留...我找不到任何标志。

感谢任何帮助！

Answer 1

为此 doxygen 具有配置设置：STRIP_CODE_COMMENTS

Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any special comment blocks from generated source code fragments. Normal C, C++ and Fortran comments will always remain visible. The default value is: YES.

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

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

Don't remove doxygen markup comments from raw source display

doxygen