在C#中,我这样注释方法:
更新
我发现了this similar question,但@edtheprogrammerguy的答案有很好的参考资料,所以我会把问题留在这里。此外,SO不允许我删除我的问题。
第二次更新
很多C# XML注释(例如)可以直接使用。如果///注释自动插入所需的summary、param和returns标记,那就太好了,但我想用一个新的代码片段来实现这个功能应该很容易。
第三次更新
这是一个插入头文件的代码片段,它并没有扫描方法参数列表,但这是一个不错的开始。将其保存到
此外,还可以看到非常好的代码片段设计器VS扩展,使创建这些变得轻而易举。
/// <summary>
/// Does absolutely nothing
/// </summary>
/// <param name="a">First useless parameter</param>
/// <param name="b">Second useless parameter</param>
/// <returns>zero</returns>
public int Foo(int a, int b)
{
return 0;
}
这将提供非常好的IntelliSense提示窗口:
更新
我发现了this similar question,但@edtheprogrammerguy的答案有很好的参考资料,所以我会把问题留在这里。此外,SO不允许我删除我的问题。
第二次更新
很多C# XML注释(例如
第三次更新
这是一个插入头文件的代码片段,它并没有扫描方法参数列表,但这是一个不错的开始。将其保存到
Documents\Visual Studio 2012\Code Snippets\Visual C++\My Code Snippets
,任意起名并使用.snippet
扩展名,重新启动VS,在方法上方键入summ
+ TAB即可激活。<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
<CodeSnippet Format="1.0.0">
<Header>
<SnippetTypes>
<SnippetType>Expansion</SnippetType>
</SnippetTypes>
<Title>SnippetFile1</Title>
<Author>dlively</Author>
<Description>Insert a summary/param/return header for a method</Description>
<HelpUrl>
</HelpUrl>
<Shortcut>summ</Shortcut>
</Header>
<Snippet>
<Declarations>
<Literal Editable="true">
<ID>summary_text</ID>
<ToolTip>summary_text</ToolTip>
<Default>Insert description of method</Default>
<Function>
</Function>
</Literal>
<Literal Editable="true">
<ID>returns_text</ID>
<ToolTip>returns_text</ToolTip>
<Default>Description of return value</Default>
<Function>
</Function>
</Literal>
<Literal Editable="true">
<ID>parameter_name</ID>
<ToolTip>parameter_name</ToolTip>
<Default>Name of the parameter</Default>
<Function>
</Function>
</Literal>
<Literal Editable="true">
<ID>parameter_description</ID>
<ToolTip>parameter_description</ToolTip>
<Default>Description</Default>
<Function>
</Function>
</Literal>
</Declarations>
<Code Language="cpp" Kind="method decl"><![CDATA[/// <summary>
/// $summary_text$
/// </summary>
/// <param name="$parameter_name$">$parameter_description$</param>
/// <returns>$returns_text$</returns>]]></Code>
</Snippet>
</CodeSnippet>
</CodeSnippets>
此外,还可以看到非常好的代码片段设计器VS扩展,使创建这些变得轻而易举。