【问题标题】:Is there away to comment the implementation of function in Doxygen是否可以评论 Doxygen 中的功能实现
【发布时间】:2014-10-14 22:58:21
【问题描述】:

我知道有类似的问题,但我没有找到可以解决我的问题的答案,我有一个由一个头文件组成的程序,其中包括多个 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 
    }

据我所知,如果我在文档中打开源文件,我会看到注释,但我想解释每个函数的作用以及它是如何工作的!

提前感谢您的帮助!

【问题讨论】:

    标签: c doxygen


    【解决方案1】:

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

    如果你只是用 // 评论它不会出现在 doxygen 上。 Doxygen 仅解析以某些标记开头的 cmets,例如 /**/*!

    【讨论】:

    • 首先我要感谢您的帮助,但在我的 cmets 中我使用 /*!
    • 这样使用 //!一个普通的成员,接受两个参数并返回一个整数值。
    • 对不起,但它显示了评论,但没有显示 HTML 页面中的变量,所以我得到了解释,但不知道评论指的是什么
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2020-03-24
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2016-10-27
    • 1970-01-01
    • 2022-01-21
    相关资源
    最近更新 更多