Doxygen结构多种语言

时间:2014-06-25 12:44:17

标签: c struct doxygen commenting

我有以下问题: 有一个结构,称之为矩阵

struct matrix {
    double** a;
    int r;
    int c;
}

现在我想用德语记录我的结构英语。

因此,我想在结构

之前简要描述所有成员
/**
 * \~german
 * \brief description
 *
 *

然后我想使用与param函数类似的语法。

有没有办法做到这一点,所以我可以解释结构代码上面的成员?

还有可能做到

int r; //!< description

但是这对于多种语言来说变得相当混乱,并且扰乱了阅读代码的流程。

感谢

编辑:

找到解决方案:

/**\struct matrix
 * \~German
 * \brief Beschreibung
 *
 * \~English
 * \brief description
 *
*/

struct matrix {
    double **a; //!<\~English comment \~German Kommentar
    int r;      //!<\~English comment \~German Kommentar
    int c;      //!<\~English comment \~German Kommentar

};

如果其中一种语言位于另一行而不是其元素上,则它无法正常工作。

1 个答案:

答案 0 :(得分:5)

终于找到了我自己的解决方案:

/**\struct matrix
 * \~German
 * \brief Struct Beschreibung
 *
 * \~English
 * \brief Struct description
 *
*/

struct matrix {
    double **a; //!<\~English comment \~German Kommentar
    int r;      //!<\~English comment \~German Kommentar
    int c;      //!<\~English comment \~German Kommentar
};

如果其中一种语言位于另一行而不是其元素上,则它无法正常工作。