怎么有意见在智能感知的功能在Visual Studio?

StackOverflow https://stackoverflow.com/questions/529677

题

在Visual Studio和C#当使用建立在功能，例如ToString()，智能感知表示黄色的盒子说明它做什么。

alt text alt text

我怎么能有用功能和性能，我写信？

有帮助吗？

解决方案

产生一个地区，在那里你可以指定一个描述的职能和每一个参数的功能、类型以下在线上之前，你的功能和打 输入:

  • C#: ///

  • VB： '''

看看 建议标签的文件的评论(C#编程指南) 更多信息结构化的内容可以包括在这些意见。

其他提示

您需要的是 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

<c>text</c> - 你想表明作为代码的文本结果。 在<< EM> C >标签为您提供了一种方法来指示的描述中的文本应该被标记为代码。使用<< EM>码>指示多个行作为代码。

<code>content</code> - 你想标记为代码的文本结果。 在<< EM>代码>标签为您提供了一种方法来指示多行作为代码。使用<< EM> C >指示描述内的文本应该被标记为代码。

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

<exception cref="member">description</exception> - 异常的描述，点击。 在<< EM>例外>标签，您可以指定哪些异常可以被抛出。该标签可以应用于定义为方法，属性，事件和索引。

<include file='filename' path='tagpath[@name="id"]' />结果 在<< EM>包括>标签可以让你指的是另一个文件中描述的类型和成员在你的源代码注释。这是直接在你的源代码文件将文档注释的替代品。通过将文档中的一个单独的文件，你可以从源代码单独申请源控制的文件。一个人可以拥有的源代码文件，签出，别人可以有文档文件签出。 在<< EM>包括>标记使用XML XPath语法。请参阅XPath文档的方式来定制您的<< EM>包括>使用。 搜索结果

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

在<< EM> listheader >块是用来定义任一个表或定义列表的标题行。当定义一个表，你只需要提供在标题为期限的条目。 列表中的每个项目与一个<< EM>项目>块指定。当创建一个定义列表，您需要同时指定期限和说明。然而，对于一个表，项目符号列表或编号列表，你只需要提供用于描述一个条目。 列表或表格可以有许多<< EM>项目>块作为必要的。

<para>content</para>结果 所述<< EM>对位>标签为标签内使用，如<< EM>摘要>，<< EM>备注>或<< EM>返回>，并允许您添加结构的文本。

<param name="name">description</param>结果 所述<< EM> PARAM >标签应当在用于方法声明的注释，用于描述该方法的参数之一。为了记录多个参数，使用多个<< EM> PARAM >标签。点击 文本的<< EM> PARAM >标签将显示在智能感知，对象浏览器，并在代码注释Web报表。

<paramref name="name"/>结果 在<< EM> paramref >标签为您提供了一种方式来表明，在代码注释的单词，例如<< EM>摘要> <<或EM>说明的>块指的是参数。该XML文件可被处理以某种鲜明方式格式化这个字，如用粗体或斜体字体。

<permission cref="member">description</permission>
在<< EM>许可>标签可以让你记录一个成员的访问。所述的PermissionSet类，可以指定访问的部件。

<remarks>description</remarks>结果 所述<< EM>备注>标记用于添加关于类型的信息，补充与<< EM>摘要>。此信息显示在对象浏览器。

<returns>description</returns>结果 在<< EM>返回>标签应该在方法声明的注释用来描述返回值。

<see cref="member"/>结果 在<< EM>见>标签让您从文本中指定的链接。使用<< EM> seealso >表明，文本应放置在参见部分。使用的cref属性为代码元素创建内部超链接到文档页面。

<seealso cref="member"/>结果 在<< EM> seealso >标签可以让你指定你可能想APPEA文本R在作为另请参见部分。使用<< EM>见>从文本中指定的链接。

<summary>description</summary>结果 所述<< EM>摘要>标签应该被用来描述一种类型或类型成员。使用<< EM>说明>将补充信息添加到类型描述。使用CREF属性，使文档的工具，如沙堡创造内部链接到文档页面的代码元素。 为<< EM>摘要的文字>标签是约在IntelliSense的类型的信息的唯一来源，并且还显示在对象浏览器。

<typeparam name="name">description</typeparam>结果 所述<< EM> typeparam >标签应当在一个通用类型或方法声明的注释用于描述一种类型的参数。添加标签的泛型类型或方法的每种类型的参数。 文本的<< EM> typeparam >标签将显示在智能感知，对象浏览器代码注释Web报表。

<typeparamref name="name"/>结果 使用这个标记，以使文档文件的消费者斜体格式化字在一些明显的方式，例如

<value>property-description</value>结果 在<< EM>值>标签可以让你描述一个属性代表的价值。请注意，当您在Visual Studio .NET开发环境通过代码向导添加属性，它会加入<< EM>摘要>标签新属性。然后，您应该手动添加一个<< EM>值>标签来描述值的属性表示。

别XML注释，这样

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

使用///开始每线的意见和评论包含的 适当的xml 对元数据的读者。

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

虽然我个人认为，这些评论通常是错误的，除非你是发展中类代码不能读取它的消费者。

那些被称为 XML评论。永远以来他们一直Visual Studio中的一个组成部分。

您可以通过使用 GhostDoc ，无外接让你的文档过程更容易为Visual Studio它为您生成XML的文档注释。只要将你想要记录的方法/属性您插入符号，然后按Ctrl-Shift键d。

下面是从一个例子

希望帮助：）

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

参阅 http://msdn.microsoft.com/en-us/library /3260k4x7.aspx 只要指定的评论不会显示在智能感知帮助的意见。

这样定义的方法，你会得到你所需要的帮助。

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

代码使用率的屏幕快照

另外，Visual Studio的插件鬼DOC将尝试创建并填写您的函数名头注释。

所有这些人的回答是有意义的，但不完整。 Visual Studio将处理XML的意见，但你必须打开它们。以下是如何做到这一点：

智能感知将使用XML注释，你在你的源代码输入，但你必须让他们通过Visual Studio选项启用。转到Tools> Options> Text Editor。对于Visual Basic，使Advanced> Generate XML documentation comments for '''设置。对于C＃，使Advanced> Generate XML documentation comments for ///设置。进入智能感知时将使用的总结意见。引用的项目进行编译后，他们将可以从其他项目。

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

注意，生成XML文件可以显着提高你的编译时间。

Solmead具有正确的答案。欲了解更多信息，你可以看看 XML评论。

许可以下： CC-BY-SA 和 归因
不隶属于 StackOverflow
scroll top