如何从doxygen函数中提取注释？ [英] How to be able to extract comments from inside a function in doxygen?

问题描述

我有兴趣知道是否有可能在函数（c，c ++，java）中有一些注释，方法是doxygen可以将它们放在生成的html文件中。

例如：

  function（...）
 {
 do_1 ）; 
 / ** 
 *调用do_2函数进行特定的操作。 
 * / 
 do_2（）; 
} 
  

解决方案

不，doxygen不支持评论阻止功能体内部。从手册中：

Doxygen允许您将文档块几乎放置在任何位置（异常在函数体内或正常内部C风格评论块）。

节： Doxygen记录代码

I'm interested to know if it is possible to have some comments in a function (c, c++, java) in a way that doxygen could put them in the generated html file.

for example:

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

解决方案

No, doxygen does not support comments blocks inside function bodies. From the manual:

Doxygen allows you to put your documentation blocks practically anywhere (the exception is inside the body of a function or inside a normal C style comment block).

Section: Doxygen documenting the code

这篇关于如何从doxygen函数中提取注释？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！