如何能够在doxygen的一个函数里提取评论？ [英] How to be able to extract comments from inside a function in doxygen?

问题描述

我很想知道是否有可能在函数的一些意见（C，C ++，JAVA）的方式，可以doxygen的把它们生成的HTML文件。

例如：

 函数（...）
{
do_1（）;
/ **
 *调用do_2功能做具体的东西。
 * /
do_2（）;
}
 

解决方案

没有，doxygen的不支持的功能里面的评论机构块。从手册：

  

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

科： Doxygen的记录了code

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屋！