如何在 IntelliSense 中为 VisualStudio 中的函数添加注释？

小开

最佳答案

要生成一个可以指定函数描述和函数参数的区域，请在函数前面的行中键入以下内容，然后按 Enter:

C # : ///
VB: '''

关于结构化内容的更多信息，请参见文档注释的推荐标记(C # 编程指南)。

小开

执行 XML 注释，如下所示

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

小开

索米德有正确的答案。更多的信息，你可以看看 XML 注释。

小开

使用//开始注释的每一行，并让注释包含元数据读取器的适当的 xml。

///<summary>
/// this method says hello
///</summary>
public void SayHello();

尽管就我个人而言，我相信这些注释通常是错误的，除非您正在开发使用者无法读取代码的类。

小开

此外，可视化工作室插件幽灵文档将尝试创建和填写来自您的函数名的标题注释。

小开

你需要的是 Xml 注释-基本上，它们遵循这样的语法(如 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

小开

这些被称为 XML 注释。它们一直以来都是 Visual Studio 的一部分。

通过使用 GhostDoc，您可以使文档处理过程变得更容易，GhostDoc是 VisualStudio 的一个免费外接程序，它可以为您生成 XML-doc 注释。只需在要记录的方法/属性上放置插入符号，然后按 Ctrl-Shift-D 即可。

这里有一个来自我的一个帖子的例子。

希望这能有所帮助:)

小开

读取 http://msdn.microsoft.com/en-us/library/3260k4x7.aspx仅指定注释将不会显示智能化的帮助注释。

小开

在 CSharp 中，如果您使用它的 Parms 创建方法/函数大纲，那么当您添加三个正斜杠时，它将自动生成摘要和 Parms 部分。

所以我输入:

public string myMethod(string sImput1, int iInput2)
{
}

然后我把///放在它的前面，Visual Studio 给了我这个:

/// <summary>
///
/// </summary>
/// <param name="sImput1"></param>
/// <param name="iInput2"></param>
/// <returns></returns>
public string myMethod(string sImput1, int iInput2)
{
}

小开

<c>text</c>-要指示为代码的文本。
< C > 标记提供了一种方法来指示说明中的文本应该标记为代码。使用 < 密码 > 表示多行代码。

<code>content</code>-要标记为代码的文本。
< 密码 > 标记为您提供了一种将多行指示为代码的方法。使用 < C > 指示说明中的文本应标记为代码。

<example>description</example>-代码示例的描述。
使用 < 例子 > 标记可以指定如何使用方法或其他库成员的示例。这通常涉及使用 < 密码 > 标记。

<exception cref="member">description</exception>-异常的描述。
< 例外 > 标记允许您指定可以引发哪些异常。此标记可应用于方法、属性、事件和索引器的定义。

<include file='filename' path='tagpath[@name="id"]' />
< 包括 > 标记允许您引用另一个文件中描述源代码中的类型和成员的注释。这是将文档注释直接放在源代码文件中的一种替代方法。通过将文档放在一个单独的文件中，可以将源代码控制应用于与源代码分开的文档。一个人可以签出源代码文件，另一个人可以签出文档文件。 < 包括 > 标记使用 XML XPath 语法。

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

< 列表头 > 块用于定义表或定义列表的标题行。在定义表时，您只需要在标题中为术语提供一个条目。列表中的每个项都使用 < 项目 > 块指定。创建定义列表时，需要同时指定术语和描述。但是，对于表、项目符号列表或编号列表，您只需提供一个用于描述的条目。根据需要，列表或表可以包含尽可能多的 < 项目 > 块。

<para>content</para>
< 停 > 标记用于标记内部，例如 < 摘要 > 、 < 评论 > 或 < 报税表 > ，并允许您向文本添加结构。

<param name="name">description</param>
应该在方法声明的注释中使用 < Param > 标记来描述方法的一个参数。要记录多个参数，请使用多个 < Param > 标记。
< Param > 标记的文本将显示在智能感知、对象浏览器和代码注释 Web 报告中。

<paramref name="name"/>
< Parref > 标记提供了一种方法来指示代码注释中的一个单词，例如在 < 摘要 > 或 < 评论 > 块中的一个单词指向一个参数。可以对 XML 文件进行处理，以便以某种不同的方式格式化这个单词，例如使用粗体或斜体字体。

< permission cref="member">description</permission>
< 允许 > 标记允许记录成员的访问。PermisonSet 类允许您指定对成员的访问权限。

<remarks>description</remarks>
< 评论 > 标记用于添加关于类型的信息，以补充用 < 摘要 > 指定的信息。此信息显示在对象浏览器中。

<returns>description</returns>
应该在方法声明的注释中使用 < 报税表 > 标记来描述返回值。

<see cref="member"/>
< 你看 > 标记允许您从文本中指定链接。使用 < 再见 > 指示文本应放置在“请参阅”部分中。使用 cref 属性创建指向代码元素的文档页面的内部超链接。

<seealso cref="member"/>
使用 < 再见 > 标记可以指定可能希望显示在“请参阅”部分中的文本。使用 < 你看 > 指定文本内的链接。

<summary>description</summary>
应该使用 < 摘要 > 标记来描述类型或类型成员。使用 < 评论 > 向类型说明添加补充信息。使用 cref Attribute 启用文档工具(如 Sandcastle)来创建指向代码元素的文档页面的内部超链接。 < 摘要 > 标记的文本是 IntelliSense 中关于该类型的唯一信息来源，也显示在对象浏览器中。

<typeparam name="name">description</typeparam>
应该在泛型类型或方法声明的注释中使用 < 护发素 > 标记来描述类型参数。为泛型类型或方法的每个类型参数添加标记。 < 护发素 > 标记的文本将显示在 IntelliSense (对象浏览器代码注释 Web 报告)中。

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

<value>property-description</value>
< 价值 > 标记允许您描述属性表示的值。请注意，在 VisualStudio 中通过代码向导添加属性时。NET 开发环境中，它将为新属性添加一个 < 摘要 > 标记。然后，您应该手动添加一个 < 价值 > 标记来描述属性表示的值。

小开

所有这些其他的答案都有意义，但是不完整。VisualStudio 将处理 XML 注释，但必须打开它们。下面是如何做到这一点:

Intellisense 将使用您在源代码中输入的 XML 注释，但必须通过 VisualStudio 选项启用它们。转到 Tools > Options > Text Editor。对于 VisualBasic，启用 Advanced > Generate XML documentation comments for '''设置。对于 C # ，启用 Advanced > Generate XML documentation comments for ///设置。当输入时，Intellisense 将使用摘要注释。在编译引用的项目之后，它们将可从其他项目获得。

要创建外部文档，您需要通过控制编译器的 /doc选项的 Project Settings > Build > XML documentation file:路径生成一个 XML 文件。您将需要一个外部工具，该工具将 XML 文件作为输入，并以您选择的输出格式生成文档。

请注意，生成 XML 文件会显著增加编译时间。

小开

像这样定义方法，您将获得所需的帮助。

    /// <summary>
/// Adds two numbers and returns the result
/// </summary>
/// <param name="first">first number to add</param>
/// <param name="second">second number to </param>
/// <returns></returns>
private int Add(int first, int second)
{
return first + second;
}

代码使用的屏幕截图