有没有评论Doxygen中函数的实现

时间:2014-08-21 10:35:00

标签: c doxygen

我知道有类似的问题,但我没有找到可以解决我的问题的答案,我的程序由一个Header文件组成,其中包含多个static变量和函数。

变量用于多个源文件,然后具有不同的含义,每次都以不同的方式实现这些功能。我的问题是如何在HTML doxygen文件中看到源文件中的注释。喜欢:

/*!<
function that does stuff
@param value representing the mean stuff 
*/

    double func(double* value){
         FILE* inp =NULL; /*!< the file pointer of this function to write the result*/
         .............................................//!* all this commments should be see in functiopn description 
    }

据我所知,如果我在文档中打开源文件,我会看到评论,但我想解释每个函数的滚动以及它是如何完成它的!

提前感谢您的帮助!

1 个答案:

答案 0 :(得分:1)

这是http://www.doxygen.nl/manual/docblocks.html#specialblock

如果您只是评论//它不会出现在doxygen上。 Doxygen仅解析以某些令牌开头的评论,例如/**/*!