106

我想知道是否有办法(希望是键盘快捷键)在 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)
4

8 回答 8

177

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

在 C# 中是///

默认吐出:

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

以下是编辑 VS 模板的一些技巧。

于 2009-01-09T21:21:05.570 回答
51

幽灵医生

右键单击该功能,选择“记录此”并

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++ ShiftD

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

话虽如此,我个人更喜欢方法是完全自文档化的,但有时你会拥有强制外部文档的编码标准,然后这样的工具将为你节省大量的无脑打字。

于 2009-01-09T21:26:04.267 回答
38
///

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

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

你会自动得到它

在此处输入图像描述

于 2016-05-10T11:16:46.353 回答
19

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 下,选择“编辑 VA Snippets”,语言:C++,类型:重构,然后转到“文档方法”并自定义。上面的例子是通过以下方式生成的:

va_doxy

于 2009-05-01T19:02:58.337 回答
14

通常,如果您在要注释的内容(方法、类)上方添加三个单个注释标记,Visual Studio 会自动创建它。

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

如果 Visual Studio 不这样做,您可以在

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

并检查

为 /// 生成 XML 文档注释

图示说明

于 2016-01-04T08:41:32.027 回答
4

在visual basic中,如果你先创建你的函数/子,然后在它上面的那一行,你输入'三遍,它会自动生成相关的xml文档。当您在智能感知中将鼠标悬停以及使用该功能时,也会出现这种情况。

于 2012-07-17T19:50:42.177 回答
2

您可以使用代码片段来插入您想要的任何行。

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

这些 XML 注释可以由文档软件解释,它们作为 assembly.xml 文件包含在构建输出中。如果您将该 XML 文件与 DLL 一起保存并在另一个项目中引用该 DLL,则这些注释将在智能感知中可用。

于 2009-01-09T19:59:50.463 回答
-1

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

http://todoc.codeplex.com/

于 2012-04-21T01:27:20.857 回答