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

Question

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

例如:

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

Answer 1

我不知道 C，但我每天都在 Objective-C 中这样做，我在其中评论如下:

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

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

呈现为:

This method performs the following operations:

• do op1

• do op2

---

编辑: 根据 Dana the Sane 的评论，关于我对 Doxygen 文档的理解以及为什么它与我的经验不矛盾。

据我对 Doxygen 文档的理解和解释，这与 quote provided by Aaron Saarela 并不矛盾。 .在他提供的链接的开头，有一段关于体内文档的内容:

For each code item there are two (or in some cases three) types of descriptions, which together form the documentation: a brief description and detailed description, both are optional. For methods and functions there is also a third type of description, the so called "in body" description, which consists of the concatenation of all comment blocks found within the body of the method or function.

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

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

但是关于体内算法的每个步骤的详细文档都由 Doxygen 完美处理。