在Visual Studio中自动生成函数文档
我想知道是否有一种方法（希望键盘快捷方式）在Visual Studio中创build自动生成函数标题。
例：
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer) 它会自动成为这样的东西…
'---------------------------------- 'Pre: 'Post: 'Author: 'Date: 'Param1 (String): 'Param2 (Integer): 'Summary: Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)
把这个“三个单独的评论标记”
在C＃中是///
作为默认吐出来：
/// <summary> /// /// </summary> /// <returns></returns>
这里有一些编辑VS模板的技巧。
GhostDoc ！
右键单击该function，select“Document this”和
private bool FindTheFoo(int numberOfFoos)
变
/// <summary> /// Finds the foo. /// </summary> /// <param name="numberOfFoos">The number of foos.</param> /// <returns></returns> private bool FindTheFoo(int numberOfFoos)
（是的，全部是自动生成的）。
它支持C＃，VB.NET和C / C ++。 它默认映射到Ctrl-Shift-D。
记住：您应该将方法签名之外的信息添加到文档中。 不要只停留在自动生成的文档。 像这样的工具的价值是它会自动生成可以从方法签名中提取的文档，所以您添加的任何信息都应该是新的信息。
话虽如此，我个人更喜欢什么时候方法是完全自我logging，但有时你会有编码标准，要求外部文件，然后这样的工具将为您节省很多braindead打字。
///
是获取方法描述注释块的快捷方式。 但是在添加之前请确保你已经写好了函数名和签名。 首先编写函数名称和签名。
然后在函数名称上方input///
你会自动得到它
Visual Assist也有一个很好的解决scheme ，而且成本高昂。
经过调整，以产生doxygen式的评论，这两个点击会产生 –
/** * Method: FindTheFoo * FullName: FindTheFoo * Access: private * Qualifier: * @param int numberOfFoos * @return bool */ private bool FindTheFoo(int numberOfFoos) { }
（在默认设置下，它有点不同。）
编辑：自定义“文档方法”文本的方法是在VassistX-> Visual Assist选项 – >build议，select“编辑VA片段”，语言：C ++，types：重构，然后转到“文档方法”并自定义。 上面的例子是由以下产生的：
通常情况下，Visual Studio会自动创build它，如果您在要评论的内容（方法，类）之上添加三个单独的注释标记。
在C＃中这将是/// 。
如果Visual Studio不这样做，你可以启用它
选项 – >文本编辑器 – > C＃ – >高级
并检查
为///生成XML文档注释
在visual basic中，如果你先创build你的函数/子，那么在它上面的行上，你键入'三次，它会自动生成相关的xml文档。 当你在intellisense中进行鼠标hover时，以及在使用该function时，这也会显示出来。
你可以使用代码片段插入你想要的任何行。
另外，如果在函数头上方的行上键入三个单引号（'''），则会插入可以填写的XML头模板。
这些XML注释可以被文档软件解释，并且作为一个assembly.xml文件包含在构build输出中。 如果使用DLL保存该XML文件并在另一个项目中引用该DLL，则这些注释将在IntelliSense中变为可用。
我正在开发一个名为Todoc的开源项目，它可以在保存文件时自动生成正确的文档输出。 它尊重现有的评论，真的是快速和stream畅。
