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

这里有一些关于编辑VS模板的技巧.

GhostDoc!

右键单击该功能,选择"Document this"和

private bool FindTheFoo(int numberOfFoos)

变

/// 

/// Finds the foo.
/// 
/// The number of foos.
/// 
private bool FindTheFoo(int numberOfFoos)

(是的,它都是自动生成的).

它支持C#,VB.NET和C/C++.它默认映射到Ctrl+ Shift+ D.

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

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

///

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

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

你会自动得到它

Visual Assist也有一个很好的解决方案,并且具有很高的成本.

在调整它以生成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'并自定义.以上示例由以下内容生成:

通常,如果在要注释的事物(方法,类)之上添加三个单个注释标记,Visual Studio会自动创建它.

在C#中,这将是///.

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

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

并检查

为///生成XML文档注释