【问题标题】:How to document struct data members outside of struct如何记录结构之外的结构数据成员
【发布时间】:2016-07-30 19:09:19
【问题描述】:

当我用 Doxygen 记录一个函数时,我可以这样做:

/*!
 * @brief does something
 * @param a first parameter
 *
 * Longer description
 */
void foo(int a) { /* */ }

但是有没有办法我可以通过这种方式记录结构成员:

/*!
 * @brief a struct
 * @??? a first struct member
 * @??? b second struct member
 *
 * Longer description
 */
struct a 
{
    int a,
    int b,
};

原因是,如果可能的话,我想避免用内联 cmets 记录我的结构成员。

【问题讨论】:

    标签: c documentation doxygen documentation-generation


    【解决方案1】:
    /*!
     * @struct str_a
     * @brief my a struct
     * @details Longer description
     *
     * @var str_a::a
     *   @brief first struct member
     *   @details detailed first struct member
     * @var str_a::b
     *   @brief brf second struct member
     *   @details detailed second struct member
     *
     */
    struct str_a
    {
        int a;
        int b;
    };
    

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2011-11-04
      • 1970-01-01
      • 2019-04-15
      • 1970-01-01
      • 2017-06-11
      • 2015-12-20
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多