如何能够从 doxygen 中的函数内部提取注释？

Question

我很想知道是否可以在函数（c、c++、java）中添加一些注释，doxygen 可以将它们放入生成的 html 文件中。

例如：

function(...)
{
do_1();
/**
 * Call do_2 function for doing specific stuff.
 */ 
do_2();
}

Answer 1

没有，doxygen的不支持内部函数体注释块。从手动：

  

Doxygen的允许你把你的文档块几乎任何地方（例外是函数体中一个普通的C风格注释块内或内部）。

科： Doxygen的记录代码

Answer 2

我不知道 C，但我每天都在 Objective-C 中这样做，我有这样的评论：

/// This method perform the following operations:
- (void) myMethodWith: (id) anObjectArgument
{
    /// - do op1
    [self op1];

    /// - do op2
    op2(anObjectArgument);
}

呈现为：

此方法执行以下操作：

• 执行操作1

• 做操作2

---

编辑： 以下是 Dana the Sane 的评论，内容涉及我对 Doxygen 文档的理解以及为什么它与我的经验并不矛盾。

据我理解和解释 Doxygen 文档，这与 报价由亚伦·萨雷拉提供. 。在他提供的链接的开头，有一段关于体内文档的内容：

对于每个代码项目，有两种（或在某些情况下有三种）描述，它们共同构成文档：简短的描述和详细描述，都是可选的。 对于方法和函数，还有第三种描述，即所谓的“主体”描述，该描述由方法或功能正文中的所有注释块的串联组成。

这意味着可以将 Doxygen 文档放在函数或方法体中吗？这就是我在答案之上所描述的内容。

在我看来，Aaron 引用的段落指的是通常放在函数或方法声明或实现前面的文档。这是描述参数、返回值等的部分。那 标题 文档不能放在函数或方法的主体内。

但有关体内算法每一步的详细文档都可以由 Doxygen 完美处理。

Answer 3

里面的代码注释是为了解释的特定实施片断为另一程序员理解，而不是为用户阅读有关功能的特征。

如果它必须证明对于用户来说，它应该做的 ouside 的功能块，就定义任何你认为必要的接口（签名以及先决条件，后置条件，使用的例子或评论）。

Answer 4

也许不是你可以把函数的代码为例。 http://www.doxygen.nl/manual/commands.html#cmdexample