微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

xml – 如何协调Visual Studio注释期望与具有Doxygen注释的代码?

为Doxygen处理编写的代码通常具有这样的行是正常的.

int myVariable; ///< description of myVariable

但是,当Visual Studio(例如VS 2015)使用这些Doxygen评论编写的代码时,myVariable的工具提示信息将显示

XML注释包含无效的XML:此位置不允许使用空格.

问题似乎是“<”的存在紧跟在“///”之后.这似乎被Visual Studio解释为信令(格式不正确)的XML内容.但是,这种组合与“<”一起出现向Doxygen发信号通知注释适用于该行的前一项,而不是下一项. 假设我们正在讨论已遵循此Doxygen约定的现有代码体.它已经在很多地方以这种方式编写. 有没有办法调整或教授或设置Visual Studio,以便它将这些注释视为正常记录前一项的注释,以便它们出现在这些项的工具提示中?

解决方法

Doxygen有不同的注释样式(请参阅手册中有关“特殊注释块”的部分,在本例中是关于“在成员之后放置文档”的段落).
在这里我们看到了可能性:

int var; /**< Detailed description after the member */
or
int var; //!< Detailed description after the member
//!<
or
int var; ///< Detailed description after the member

在这种情况下,我们可以从///<到//!<

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。