2017-04-13 230 views
1

我已经证明这样的功能:获取的Visual Studio 2015年认识到Doxygen注释

/** 
* Does something useful 
*/ 
int foo(Bar bar) 
{ 
    // my function 
} 

但是,当我在其他地方悬停功能的智能感知不显示它。当我将它悬停在定义上时,我看到* Does something useful,这也不正确(星星不应该在那里)。 Doxygen运行正常,Eclipse会显示文档注释,就像您期望的那样。

+0

你好,你的意思是'DoxygenComments'的扩展,对不对?如果是这样,我发现这个扩展是适用于VS 2010/2012/2013,不包括VS 2015,请检查DoxygenComments下载页面:https://marketplace.visualstudio.com/items?itemName=OleksandrManenko.DoxygenComments如果你有以前的VS版本在你的电脑上,你可以试试这个相同的功能。您可以将此问题报告给DoxygenComments开发人员以寻求更专业的支持。 –

+0

我看到了这个,但它已经过时了,所以我甚至没有尝试过。我认为VS应该展示没有任何扩展的摘要,不是吗?目前我只是想让这个工作,即使像DoxygenComments这样的东西真的很好。 – allo

+0

是的,VS内置了注释功能,对于C#代码,你可以在定义前的行上输入///,编辑器创建一个文档注释模板并填写参数和其他信息,请检查这个例如:https://1drv.ms/i/s!Atv5QNuFrncKgmXl_rTqrjpZ-tMW。对于VB,您可以使用注释符号('):https://msdn.microsoft.com/en-us/library/bx185bk6.aspx。对于C++,可以使用他评论字符(/ *,* /和//):https://msdn.microsoft.com/en-us/library/k1dbk8bw。aspx –

回答

2

从版本2016.2开始,JetBrains ReSharper为C++文件中的Doxygen文档提供支持。从this blog post我引述:

Doxygen的无疑是在C++世界中的代码 文档最流行的格式和工具。 ReSharper C++现在可以理解Doxygen 的语法,并提供了几个关键功能来方便编辑 文档块。

  • 打字帮助有助于创建新注释块并保持现有结构的 结构。
  • 代码完成提示Doxygen命令及其附带的简短描述。
  • 使用\ param命令引入的函数参数引用将由Find Usages报告,并且在使用Rename更改函数参数的名称时将会更新。
  • 当函数参数引用不解析为现有函数参数时发出警告。
  • 文档生成:您现在可以为C++声明符,类和宏定义生成文档。
  • 快速文档:文档现在可以在C++中使用。文档弹出窗口(绑定到Visual Studio方案中的Ctrl + Shift + F1或IntelliJ IDEA方案中的Ctrl + Q)将显示Doxygen注释块中的文档,或者如果未找到文档,则显示符号的签名。

应当注意的是,这款产品是不是免费的,使用它,你需要购买一个许可证。

+0

谢谢,但我认为这有点贵。我可能花费的金额较小,但在这个价格下的一年后版本的订阅模式对我来说不是一个解决方案,因为我可能只会使用一些功能。 – allo