代码之家 › 专栏 › 技术社区 › INS

如何从doxygen中的函数内部提取注释?

doxygen documentation c c++ java

5

INS · 技术社区 · 17 年前

我很想知道,如果函数可以在DyxGEN中放入一些注释,那么在函数(C,C++,java)中可以有一些注释。

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

4 回复 | 直到 17 年前

1

17

Community Mohan Dere 9 年前

我不知道C的情况,但我每天都在Objective-C中这样做,在那里我有如下评论:

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

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

操作:

执行op1

执行op2

以下是Dana the Sane关于我对Doxygen文档的理解以及为什么它与我的经验不矛盾的评论。

就我理解和解释Doxygen文档而言,这与 quote provided by Aaron Saarela

对于每个代码项,有两个(或在某些情况下,有三种文件:简要说明和说明详细描述,两者都是 对于方法和函数描述,即所谓的“体内” 描述,其中包括作用

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

在我看来,Aaron引用的段落指的是通常放在函数或方法声明或实现前面的文档。它描述了参数、返回值等。那个文档不能放在函数或方法的主体中。

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

2

8

albert 7 年前

否,doxygen不支持函数体中的注释块。从手册中:

Doxygen允许您将文档块放在几乎任何地方(例外情况是在函数体内部或普通的C风格注释块内部)。

Doxygen documenting the code

3

5

David Rodríguez - dribeas 17 年前

代码中的注释是为了解释一个特定的实现片段,让其他程序员理解,而不是供用户阅读的函数特性。

如果必须为用户记录,则应该这样做功能块,位于定义接口的注释上(签名以及前置条件、后置条件、使用示例或您认为必要的任何内容)。

4

0

albert 7 年前

http://www.doxygen.nl/manual/commands.html#cmdexample