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

【问题标题】：Auto generate function documentation in Visual Studio在 Visual Studio 中自动生成函数文档
【发布时间】：2009-01-09 19:52:34
【问题描述】：

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

【问题讨论】：

如果您登陆此页面是因为此功能在您的 IDE 中似乎已损坏，您应该确保您的代码编译并重试。当您的代码出现解析错误时，此功能不起作用。
如何在 xamarin 中生成待办事项列表？

标签： function visual-studio-2008 header auto-generate

【解决方案1】：

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

在 C# 中是///

默认吐出：

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

这里是some tips on editing VS templates.

【讨论】：

在 VB.NET 中它是三个单引号（如其他答案中所述）
很漂亮，不知道这个
如果前面的非空白行以“///”开头，则“为 /// 生成 XML 文档 cmets”将不起作用
是否可以在每个方法、属性和变量上自动执行此操作？即使代码已经存在？
提示链接已修复再次。诅咒你，单向网络！

【解决方案2】：

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。

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

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

【讨论】：

这正是我讨厌的那种“文档”。它只是添加字节而没有告诉我任何方法和参数名称还没有告诉我。不要这样做，除非将评论编辑成一些有价值的东西...... :-(
当然你应该编辑它来添加信息。但是作为模板还是很不错的。
@Rasmus：这是一个模板，为了获得好的文档，应该完全丢弃并重写，因为它没有信息内容。所以它实际上比只是空白更努力。

【解决方案3】：

///

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

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

你会自动得到它

【讨论】：

不错的不寻常的帖子功能，你的动画。
你是怎么做到的？我喜欢这个答案。以前从未见过。
很好。一项添加是函数的参数。

【解决方案4】：

Visual Assist 也有一个nice solution，并且是高度可定制的。

在调整它以生成 doxygen 样式的 cmets 后，这两次点击将产生 -

/**
* 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”，语言：C++，类型：重构，然后转到“文档方法”并自定义。上面的例子是由：

【讨论】：

请分享您在 VA 中的设置方式
详细解答。希望这会有所帮助。
插入片段：光标在方法名称/签名中，alt+shift+q > "document method"

【解决方案5】：

通常，如果您在要评论的内容（方法、类）上方添加三个单独的评论标记，Visual Studio 会自动创建它。

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

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

中启用它

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

并检查

为 /// 生成 XML 文档 cmets

【讨论】：

【解决方案6】：

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

【讨论】：

【解决方案7】：

您可以使用代码 sn-ps 插入您想要的任何行。

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

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

【讨论】：

那是 VB.NET：在 C# 中是 ///

【解决方案8】：

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

http://todoc.codeplex.com/

【讨论】：