如何在IntelliSense中的function在Visual Studio中的意见？
在Visual Studio和C＃中，当使用诸如ToString（）之类的内置函数时，IntelliSense会显示一个黄色框来解释它的function。
替代文字http://i44.tinypic.com/2r7rom8.jpg 替代文字http://i43.tinypic.com/5mcm4g.jpg
我怎么能为我写的function和属性呢？
要生成一个区域，您可以在该区域中指定函数的描述和函数的每个参数，请在函数前面input以下内容并按Enter ：
-
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> – 您要表示为代码的文字。
< c >标签为您提供了一种方式来指示描述中的文本应标记为代码。 使用< code >指示多行作为代码。
<code>content</code> – 你想标记为代码的文本。
< code >标签为您提供了将多行代码指示的方法。 使用< c >来表示描述中的文本应该被标记为代码。
<example>description</example> – 代码示例的说明。
< example >标签可让您指定如何使用方法或其他库成员的示例。 这通常涉及使用< code >标签。
<exception cref="member">description</exception> – <exception cref="member">description</exception>的描述。
< exception >标签可以让你指定哪些exception可以被抛出。 这个标签可以应用于方法，属性，事件和索引器的定义。
<include file='filename' path='tagpath[@name="id"]' />
< include >标签可以让你引用另一个文件中的注释来描述源代码中的types和成员。 这是将文档注释直接放在源代码文件中的替代方法。 通过将文档放在单独的文件中，可以将源代码控制与源代码分开使用。 一个人可以签出源代码文件，其他人可以将文档文件签出。 < include >标记使用XML XPath语法。 有关如何自定义< include >用法的信息，请参阅XPath文档。
<list type="bullet" | "number" | "table"> <listheader> <term>term</term> <description>description</description> </listheader> <item> <term>term</term> <description>description</description> </item> </list>
< listheader >块用于定义表或定义列表的标题行。 定义表格时，只需要在标题中提供一个词条。 列表中的每个项目都用< item >块指定。 创build定义列表时，您需要指定术语和说明。 但是，对于表格，项目符号列表或编号列表，您只需提供一个条目来进行说明。 一个列表或表格可以根据需要有多less个< item >块。
<para>content</para>
< para >标记用于标记中，如< summary >，< remarks >或< returns >，并允许您将结构添加到文本中。
<param name="name">description</param>
应在方法声明的注释中使用< param >标记来描述该方法的一个参数。 要logging多个参数，请使用多个< param >标签。
< param >标签的文本将显示在智能感知，对象浏览器和代码注释networking报告中。
<paramref name="name"/>
< paramref >标签使您可以指示代码注释中的单词，例如< summary >或< remarks >块中的单词是指参数。 可以处理XML文件以某种不同的方式格式化该单词，例如用粗体或斜体字体。
< permission cref="member">description</permission>
< permission >标签可以让你logging成员的访问。 PermissionSet类允许您指定对成员的访问权限。
<remarks>description</remarks>
< remarks >标记用于添加有关types的信息，补充< summary >指定的信息。 该信息显示在对象浏览器中。
<returns>description</returns>
应该在方法声明的注释中使用< returns >标记来描述返回值。
<see cref="member"/>
< see >标签可以让你从文本中指定一个链接。 使用< seealso >来指示文本应该放在一个See Also部分。 使用cref Attribute创build内部超链接到代码元素的文档页面。
<seealso cref="member"/>
< seealso >标签可让您指定您想要在“另请参阅”部分中显示的文本。 使用< see >从文本中指定一个链接。
<summary>description</summary>
< summary >标签应该用来描述一个types或者一个types成员。 使用< remarks >将补充信息添加到types描述中。 使用cref属性来启用Sandcastle等文档工具来创build内部超链接到代码元素的文档页面。 < summary >标记的文本是有关IntelliSense中types的唯一信息源，并且也显示在对象浏览器中。
<typeparam name="name">description</typeparam>
应该在注释中使用< typeparam >标签来描述types参数。 为genericstypes或方法的每个types参数添加一个标签。 对象浏览器代码注释Web报告IntelliSense中将显示< typeparam >标记的文本。
<typeparamref name="name"/>
使用此标记可使文档文件的使用者以某种不同的方式对单词进行格式化，例如以斜体显示。
<value>property-description</value>
< value >标签可以让你描述一个属性所代表的值。 请注意，当您在Visual Studio .NET开发环境中通过代码向导添加属性时，它将为新属性添加一个< summary >标记。 然后，您应该手动添加一个< value >标记来描述该属性所代表的值。
像这样做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-doc注释）来简化文档处理过程。 只要把你的光标放在你要logging的方法/属性上，然后按下Ctrl-Shift-D。
这是我的一个post的例子。
希望帮助:)
在CSharp中，如果使用Parms创build方法/函数大纲，那么当您添加三个正斜杠时，它将自动生成摘要和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) { }
定义这样的方法，你将得到你需要的帮助。
/// <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; }
代码使用的屏幕截图
Solmead有正确的答案。 欲了解更多信息，你可以看看XML评论 。
此外，可视化工作室插件ghost文档将尝试创build并填写来自函数名称的标题注释。
所有这些其他答案是有道理的，但是不完整。 Visual Studio将处理XML注释，但您必须打开它们。 以下是如何做到这一点：
Intellisense将使用您在源代码中input的XML注释，但必须通过Visual Studio选项启用它们。 转到Tools > Options > Text Editor 。 对于Visual Basic，启用“ Advanced >“ Generate XML documentation comments for '''设置。 对于C＃，启用Advanced > Generate XML documentation comments for ///设置。 Intellisense将在input时使用汇总注释。 引用的项目编译完成后，将可以从其他项目中获得。
要创build外部文档，您需要通过控制编译器的/doc选项的“ Project Settings >“ Build > XML documentation file:path来Build XML documentation file: 。 您将需要一个外部工具，将XML文件作为input，并根据您select的输出格式生成文档。
请注意，生成XML文件会显着增加编译时间。
