【发布时间】:2014-08-16 00:54:41
【问题描述】:
我有以下问题: 有一个struct,叫matrix
struct matrix {
double** a;
int r;
int c;
}
现在我想用德语和英语记录我的结构。
因此我想简要描述结构之前的所有成员
/**
* \~german
* \brief description
*
*
然后我想使用与带参数的函数类似的语法。
有没有办法做到这一点,所以我可以解释结构的代码上面的成员?
也有可能做
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
};
如果其中一种语言位于其元素之外的另一行,则它无法正常工作。
【问题讨论】:
-
当我很好理解时,您希望生成您的文档的德语和英语版本。您可能必须生成两次文档并使用您指定的语言可能性或使用 \cond 构造。
-
我只是想问一下,是否可以将其编写为类似于 @param 的函数。有没有类似的方法?我可以解释/评论类似于结构上方的函数参数的结构成员吗?
-
如果您找到了解决方案,请将其作为答案发布并接受。