在Visual Studio中自动生成函数文档
Rya*_*n M 84 header function auto-generate visual-studio-2008
我想知道是否有一种方法(希望键盘快捷方式)在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)
Mic*_*nis 152
制作"三个单一评论标记"
在C#中它是 ///
默认情况下吐出:
/// <summary>
///
/// </summary>
/// <returns></returns>
- 在VB.NET中,它是三重单引号(如其他答案中所述) (7认同)
Ras*_*ber 46
右键单击该功能,选择"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.
请记住:您应该将方法签名之外的信息添加到文档中.不要只停留自动生成的文档.像这样的工具的价值在于它会自动生成可以从方法签名中提取的文档,因此您添加的任何信息都应该是新信息.
话虽这么说,我个人更喜欢方法完全自我记录,但有时你会有编码标准,要求外部文档,然后像这样的工具将为你节省大量的脑力输入.
- 这正是我讨厌的那种"文档".它只是添加字节而不告诉我方法和参数名称没有告诉我任何东西.不要这样做,不要将评论编辑成一些值得的...... :-( (15认同)
- 当然你应该编辑它来添加信息.但作为模板,它非常好. (12认同)
- @Rasmus:这是一个模板,对于良好的文档,应该完全抛弃并重写,因为它没有信息内容.所以它实际上比它只是空白更多的努力. (2认同)
Bim*_*zee 33
///
获取方法描述注释块的快捷方式.但在添加之前,请确保已编写函数名称和签名.首先编写函数名称和签名.
然后在函数名称上方输入///
你会自动得到它
- 非常不寻常的特征,你的动画. (3认同)
- 这真好.一个加法将是函数的参数. (2认同)
Ofe*_*lon 18
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'并自定义.以上示例由以下内容生成:
- 插入代码片段：将光标放在方法名称/签名上，alt+shift+q >“文档方法” (2认同)
Dom*_*see 11
通常,如果在要注释的事物(方法,类)之上添加三个单个注释标记,Visual Studio会自动创建它.
在C#中,这将是///.
如果Visual Studio不这样做,您可以启用它
选项 - >文本编辑器 - > C# - >高级
并检查
为///生成XML文档注释
在 Visual Basic 中，如果您首先创建函数/子，然后在其上方的行中键入 ' 三次，它将自动生成相关的 xml 文档。当您将鼠标悬停在智能感知中以及使用该功能时，也会显示这一点。