0

问题与Using Doxygen with C有关,你评论函数原型还是定义?或两者?.

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

唉,有没有像 \param[in] 或 \return[in] 这样的参数,我可以在 .c 定义之前使用 html 输出来直观地指示“现在我正在描述实现”?它可以在左侧加粗体,甚至可以更改颜色以在视觉上将其设置为关闭。明显的 \implements 标签并没有这样做。

看了下生成的doxygen html代码,没有明显的css类要改。所以我大概应该使用来自http://www.doxygen.nl/manual/commands.html的标签。别人用什么?

4

1 回答 1

0

一种不理想但确实具有简单优点的选项是使用该\note命令。

为描述实现的段落加上前缀\note将导致它们在输出中显示为绿色'y-黄色侧边栏。您可以更改 CSS 中的颜色。后续\note段落将保留为单独的段落,但只有一个标题和侧边栏。

缺点是该部分的标题为注: . 这可能会或可能不会满足您的需求。

可以改用\xrefitem它,这将允许您将文本更改为Implementation:,但它相当合理地还会在单独的交叉引用页面上生成一个条目 - 这可能是不可取的。可能有一种禁用交叉索引的方法,但手册中没有关于它的内容。

我假设您正在生成一个仅供内部使用的文档;也许某种形式的技术手册?在这种情况下,“注意”选项可能是最快和最简单的解决方案。

编辑:我刚刚找到了\remark命令。本质上相当于\note没有侧边栏,但相关的标题备注可能更适合您的应用程序。您可以在 CSS 中添加侧边栏。

于 2013-11-05T11:36:11.797 回答