在Visual Studio中自动生成函数文档

Question

我想知道是否有一种方法（希望键盘快捷方式）在visual studio中创建自动生成函数头。

例：

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)

Answer 1

制作“三个单一评论标记”

在C＃中它是///

默认情况下吐出：

/// <summary>
/// 
/// </summary>
/// <returns></returns>

这是some tips on editing VS templates.

Answer 2

GhostDoc！

右键单击该功能，选择“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.

请记住：您应该将方法签名之外的信息添加到文档中。不要只停留自动生成的文档。像这样的工具的价值在于它会自动生成可以从方法签名中提取的文档，因此您添加的任何信息都应该是新信息。

话虽这么说，我个人更喜欢方法完全自我记录，但有时你会有编码标准，要求外部文档，然后像这样的工具将为你节省大量的脑力输入。

Answer 3

///

获取方法描述注释块的快捷方式。但在添加之前，请确保已编写函数名称和签名。首先编写函数名称和签名。

然后在函数名称上方输入///

你会自动得到它

Answer 4

Visual Assist也有nice solution，并且可高度定制。

在调整它以生成doxygen风格的注释后，这两次点击会产生 -

/**
* Method:    FindTheFoo
* FullName:  FindTheFoo
* Access:    private 
* Qualifier:
* @param    int numberOfFoos
* @return   bool
*/
private bool FindTheFoo(int numberOfFoos)
{

}

（在默认设置下，它有点不同。）

---

编辑：自定义“文档方法”文本的方法是在VassistX-> Visual Assist Options-> Suggestions下，选择'Edit VA Snippets'，Language：C ++，Type：Refactoring，然后转到'Document Method'并自定义。以上示例由以下内容生成：

Answer 5

通常，如果在要注释的事物（方法，类）之上添加三个单个注释标记，Visual Studio会自动创建它。

在C＃中，这将是///。

如果Visual Studio不这样做，您可以启用它

选项 - >文本编辑器 - > C＃ - >高级

并检查

为///生成XML文档注释

Answer 6

在visual basic中，如果首先创建函数/ sub，然后在它上面的行上键入“三次”，它将自动生成相关的xml文档。当您在智能感知中鼠标悬停时以及使用该功能时，也会显示此信息。

Answer 7

您可以使用代码段插入所需的任何行。

此外，如果在函数头上方的行上键入三个单引号（'''），它将插入您可以填写的XML头模板。

这些XML注释可以由文档软件解释，它们作为assembly.xml文件包含在构建输出中。如果您使用DLL保留该XML文件并在另一个项目中引用该DLL，那么这些注释将在intellisense中提供。

Answer 8

我正在开发一个名为Todoc的开源项目，该项目分析单词以在保存文件时自动生成适当的文档输出。它尊重现有的评论，并且非常快速且流畅。

http://todoc.codeplex.com/