Visual Studio 2013文档注释

3
Visual Studio是否有类似于典型的Java IDE的功能,以便于输入C++文档注释?
例如,在我的Java IDE中,当我将光标置于函数/方法之前并输入/**,然后按Enter键,IDE会自动生成注释模板。注释模板包括函数/方法的参数。然后,我手动填写每个参数的文档说明。
为了进一步澄清,请考虑以下函数:
function int foo (int id);

步骤:

  1. 将光标放在该函数之前的行上。
  2. 输入/**并按Enter或类似的键。 (我所知道的每个Java编辑器都可以使用此方法。)

结果:

/**
 * @param id
 * @return
 */
3个回答

1

三斜杠。将光标放在函数上方,然后键入///

生成包括参数的注释存根,可以进行爬取以编译文档。


我不想要XML注释,只需要普通的注释,例如/**这是我的foo函数@param id */ - user1097772
1
你确定吗?///注释的好处是它们可以在Intellisense中使用。这意味着当您开始键入函数、类、接口等时,会弹出注释。在消除一堆自定义函数的歧义时非常方便。此外,请参阅以下文章以获取自动文档:https://msdn.microsoft.com/zh-cn/magazine/cc302121.aspx - Randy Castleberry
我听说过这个,但你需要安装一些东西到Visual Studio中才能让它正常工作,它不能自然运行。(但是我对微软还有什么期望呢...) - user1097772
@RandyCastleberry:你提到的文章讨论了C#的XML文档注释。相反,请参见[XML文档(Visual C++)](https://msdn.microsoft.com/en-us/library/ms177226.aspx)。 - DavidRR

1

那么DoxygenComments扩展怎么样?

编辑:刚刚看到它只会突出显示注释而不会创建它们。Atomineer Pro可以做到,但它是收费的。


0
选中文本块并使用CTRL+KCTRL+C在其周围添加注释。使用CTRL+KCTRL+U取消注释。 您还可以尝试使用 GhostDoc Visual Studio 扩展程序。

1
你没有理解我的问题。请查看编辑注释。我不想评论代码块,我想要为函数/类等“生成”注释,其中将包括@params,@return(等等,但这可能是我需要的全部内容) - user1097772
2
我不确定在VS本身是否可能实现,但有一些插件可以做到。我现在正在使用Visual Assist,它让你几乎可以做到这一点,只是有点难以启动和运行。 - QualityPixels

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接