C# 如何在VisualStudio中为函数提供IntelliSense中的注释？

在Visual Studio和C#中，当使用内置函数（如ToString（））时，IntelliSense会显示一个黄色框，说明它的功能

---

如何将其用于我编写的函数和属性？

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

• C:

  /

• VB:

  ''

---

有关这些注释中可以包含的结构化内容的更多信息，请参阅。

像这样做XML注释

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

//
///这真是太棒了
/// 
public void doesmethingawesome（）{}
索尔米德的答案是正确的。有关更多信息，您可以查看。
使用///开始注释的每一行，并使注释包含元数据读取器的

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

///
///这个方法说你好
///
公共空间：SayHello（）；

尽管就个人而言，我认为这些注释通常是错误的，除非您开发的类的代码不能被其使用者读取。
visual studio插件ghost文档也会尝试从您的函数名创建并填充标题注释。
您需要的是xml注释-基本上，它们遵循以下语法（如索尔米德模糊描述的）：

C#

///
///这是对我的功能的描述。
///
字符串myFunction（）{
返回“废话”；
}

VB

“”
''这是对我功能的描述。
'''
函数myFunction（）作为字符串
返回“废话”
端函数
这些被称为。他们一直以来都是VisualStudio的一部分

您可以使用Visual Studio的一个免费外接程序，为您生成XML文档注释，从而简化文档处理过程。只需将插入符号放在要记录的方法/属性上，然后按Ctrl-Shift-D

这里有一个例子

希望有帮助：）
阅读仅指定注释不会在intellisense中显示帮助注释。
在CSharp中，如果您使用参数创建方法/函数大纲，那么当您添加三个正向斜杠时，它将自动生成摘要和参数部分

因此，我提出：

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)
{
}

//
/// 
/// 
/// 
/// 
/// 
公共字符串myMethod（字符串sImput1，int iInput2）
{
}
文本
-您希望指示为代码的文本。

标记为您提供了一种指示说明中的文本应标记为代码的方法。用于将多行指示为代码

内容
-要标记为代码的文本。

标记提供了一种将多行指示为代码的方法。用于指示说明中的文本应标记为代码

说明
-代码示例的说明。

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

说明
-异常的说明。

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



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




学期
描述
学期
描述

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

内容


标记用于标记内部，例如，或，并允许向文本添加结构

说明


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

标记的文本将显示在对象浏览器IntelliSense和代码注释Web报告中



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

说明


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

说明


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

说明


标记应在方法声明的注释中使用，以描述返回值



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

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

    /// <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;
    }