如何为“C”添加 Doxygen 注释具有长类型名称的变量
我有一个代码，
static const guint8 variable;
当我放置文档时，
/** * \var static const guint8 variable; * \brief This is a variable */ static const guint8 variable;
但在生成的文档中没有得到任何输出。然而，当用简单的变量减速完成同样的事情时：
/** * \var int someothervar; * \brief This is some other variable */ int variable;
它确实有效
，但我在使用中犯了一些错误？
感谢您提前提供的任何帮助，
- 埃莱基
I have a code
static const guint8 variable;
when I put a documentation
/** * \var static const guint8 variable; * \brief This is a variable */ static const guint8 variable;
I do not get any output in the generated documentation. However, when the same thing is done with a simple variable decleration:
/** * \var int someothervar; * \brief This is some other variable */ int variable;
it does work
is that I am making some mistake in the usage ?
Thanks for any help in advance,
- elechi
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（1）
要提取静态变量，您应该将 EXTRACT_STATIC 设置为 YES。
如果文档位于变量前面，则不需要（也不应该使用） \var
将 EXTRACT_ALL 设置为 YES 或在代码中使用 @file 命令添加注释来记录文件本身。
For extracting static variables you should set EXTRACT_STATIC to YES.
If the documentation is in front of the variable, you do not need (and should not use) \var
Either set EXTRACT_ALL to YES or add a comment with a @file command in your code to document the file itself.