doxygen:C中声明与定义的html格式_C_Doxygen

doxygen:C中声明与定义的html格式

c doxygen

doxygen:C中声明与定义的html格式,c,doxygen,C,Doxygen,这个问题涉及到 doxygen格式化使my.h文件中的声明及其注释首先出现，然后是my.c文件中的定义及其注释。好唉，在html输出的.c定义之前，有没有像\param[in]或\return[in]这样的参数可以用来直观地表示“现在我正在描述实现”？它可以在左边加一个黑体字，甚至可以改变颜色，使它在视觉上显得更加醒目。明显的\implements标记不这样做我查看了生成的doxygen html代码，没有明显的css类需要更改。所以我大概应该使用来自的标记。其他人使用什么？一个不理想但具有

这个问题涉及到

doxygen格式化使my.h文件中的声明及其注释首先出现，然后是my.c文件中的定义及其注释。好

唉，在html输出的.c定义之前，有没有像\param[in]或\return[in]这样的参数可以用来直观地表示“现在我正在描述实现”？它可以在左边加一个黑体字，甚至可以改变颜色，使它在视觉上显得更加醒目。明显的\implements标记不这样做

我查看了生成的doxygen html代码，没有明显的css类需要更改。所以我大概应该使用来自的标记。其他人使用什么？

一个不理想但具有简单优点的选项是使用

\note

命令

在描述实现的段落前面加上

\note

将导致它们在输出中显示为绿色的y黄色边栏。您可以更改CSS中的颜色。后续的

\note

段落将保留为单独的段落，但只有一个标题和侧栏

缺点是该部分的标题为注：。这对于您的需求可能是可以接受的，也可能是不可以接受的

您可以改为使用

\xrefitem

，这将允许您将文本更改为实现：，但它也会在单独的交叉引用页面上生成一个条目，这可能是不可取的。可能有一种方法可以禁用交叉索引，但在本手册中对此没有任何说明

我假设您生成的文档仅供内部使用；也许是某种形式的技术手册？在这种情况下，“Note”选项可能是最快、最简单的解决方案

编辑：我刚刚找到了

\remark

命令。本质上等同于没有侧栏的

\note