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

https://stackoverflow.com/questions/429452

06-07-2019
|

题

我想知道是否有一种方法（希望是键盘快捷方式）在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)

解决方案

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

在C＃中，它是 ///

默认情况下吐出：

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

这是有关编辑VS模板的一些提示。

其他提示

GhostDoc ！

右键单击该功能，选择“记录此项”。和

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 。

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

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

///

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

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

你将自动获得

Visual Assist也有一个漂亮的解决方案，并且具有极高的成本。

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

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

}

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

编辑：自定义“文档方法”文本的方法是在VassistX-＆gt; Visual Assist Options-＆gt; Suggestions下，选择'Edit VA Snippets'，Language：C ++，Type：Refactoring，然后转到'Document Method'并自定义。上面的例子是由：

生成的