问如何在IntelliSense中为Visual Studio中的函数添加注释？

EN

您需要的是Solmead注释-基本上，它们遵循以下语法(正如模糊地描述的那样)：

C#

///<summary>
///This is a description of my function.
///</summary>
string myFunction() {
     return "blah";
}

VB

'''<summary>
'''This is a description of my function.
'''</summary>
Function myFunction() As String
    Return "blah"
End Function

<c>text</c> -要指示为代码的文本。

标记为您提供了一种指示描述中的文本应标记为代码的方法。使用将多行表示为代码。

<code>content</code> -要标记为代码的文本。

标记为您提供了一种将多行表示为代码的方法。使用指示描述中的文本应标记为代码。

<example>description</example> -代码示例的描述。

标记允许您指定如何使用方法或其他库成员的示例。这通常涉及到使用标记。

<exception cref="member">description</exception> -异常的描述。

标记允许您指定可以抛出哪些异常。此标记可应用于方法、属性、事件和索引器的定义。

<include file='filename' path='tagpath[@name="id"]' />

标记允许您引用另一个文件中描述源代码中的类型和成员的注释。这是直接在源代码文件中放置文档注释的另一种选择。通过将文档放在单独的文件中，您可以将源代码控制与源代码分开应用于文档。一个人可以签出源代码文件，另一个人可以签出文档文件。XML标记使用 XPath语法。有关自定义使用的方法，请参阅XPath文档。

<list type="bullet" | "number" | "table">
    <listheader>
        <term>term</term>
        <description>description</description>
    </listheader>
    <item>
        <term>term</term>
        <description>description</description>
    </item>
</list>

块用于定义表格或定义列表的标题行。在定义表时，您只需在标题中为term提供一个条目。列表中的每一项都使用块指定。创建定义列表时，需要同时指定术语和描述。但是，对于表格、项目符号列表或编号列表，只需提供描述条目。列表或表可以具有所需的任意多个块。

<para>content</para>

标签用于在、或等标签内使用，并允许您向文本中添加结构。

<param name="name">description</param>

应该在方法声明的注释中使用标记来描述该方法的一个参数。要记录多个参数，请使用多个标记。

标记的文本将显示在IntelliSense、对象浏览器和Code Comment Web Report中。

<paramref name="name"/>

标记提供了一种方法来指示代码注释中的单词引用参数。可以对XML文件进行处理，以便以某种不同的方式格式化该单词，例如使用粗体或斜体字体。

<permission cref="member">description</permission>

标记允许您记录成员的访问。PermissionSet类允许您指定对成员的访问权限。

<remarks>description</remarks>

标记用于添加有关类型的信息，补充用指定的信息。此信息显示在对象浏览器中。

<returns>description</returns>

应该在方法声明的注释中使用标记来描述返回值。

<see cref="member"/>

标签允许您从文本中指定链接。使用指示文本应放置在“请参阅”部分中。使用cref属性可以创建指向代码元素文档页的内部超链接。

<seealso cref="member"/>

标记使您可以指定可能要显示在“请参阅”部分中的文本。使用指定文本内的链接。

<summary>description</summary>

标记应用于描述类型或类型成员。使用将补充信息添加到类型描述中。使用cref属性可以使文档工具(如Sandcastle )创建指向代码元素的文档页的内部超链接。在IntelliSense中，标记的文本是有关该类型的唯一信息来源，并且还会显示在对象浏览器中。

<typeparam name="name">description</typeparam>

泛型类型或方法声明的注释中应使用标记来描述类型参数。为泛型类型或方法的每个类型参数添加标记。标记的文本将显示在对象浏览器代码注释web报告IntelliSense中。

<typeparamref name="name"/>

使用此标记使文档文件的使用者能够以某种不同的方式格式化单词，例如斜体。

<value>property-description</value>

标记允许您描述属性表示的值。请注意，当您在Visual Studio .NET开发环境中通过代码向导添加属性时，它将为新属性添加一个标记。然后，您应该手动添加一个标记来描述该属性表示的值。

进行XML注释，如下所示

/// <summary>
/// This does something that is awesome
/// </summary>
public void doesSomethingAwesome() {}