原文链接:http://www.shinater.com/DocsBuilder/help.html

<summary>description</summary>
描述类型或类型成员。 
description:对象的摘要。
<remarks>description</remarks>
添加有关某个类型的信息,从而补充由 <summary> 所指定的信息。 
description:成员的说明。
<example>description</example>
使用方法或其他库成员的示例。这通常涉及使用 <code> 标记。 
description:代码示例的说明。
<seealso cref="member"/>
指定希望在“请参见”一节中出现的文本。 
member:对可以通过当前编译环境进行调用的成员或字段的引用。必须将 member 括在双引号 (" ") 中。
<typeparam name="name">description</typeparam>
描述泛型类型或方法的单个类型参数。 
name:类型参数的名称。将此名称用双引号括起来 (" ")。 
description:类型参数的说明。
<param name="name">description</param>
描述方法的单个参数。 
name:方法参数名。将此名称用双引号括起来 (" ")。 
description:参数说明。
<returns>description</returns>
描述方法的返回值。 
description:返回值的说明。
<value>property-description</value>
描述属性所代表的值。 
property-description:属性的说明。
<permission cref="member">description</permission>
成员的访问权限。使用 PermissionSet 类可以指定对成员的访问。 
member:对可从当前编译环境中获取的权限的引用。必须将 member 括在双引号 (" ") 中。 
description:对成员的访问的说明。
<exception cref="member">description</exception>
指定哪些异常可能被引发。此标记可用在方法、属性、事件和索引器的定义中。 
member:对可从当前编译环境中获取的异常的引用。必须将 member 括在双引号 (" ") 中。 
description:异常的说明。
<c>text</c>
将说明中的文本标记为代码。 
text:希望将其指示为代码的文本。
<code>content</code>
将多行文本指示为代码。 
content:希望将其指示为代码的文本。
<see cref="member"/>
从文本内指定链接。 
member:对可以通过当前编译环境进行调用的成员或字段的引用。应将 member 放在双引号 (" ") 中。
<paramref name="name"/>、<typeparamref name="name"/>
分别引用某个参数或某个类型参数。 
member:要引用的参数名(类型参数的名称)。将此名称用双引号括起来 (" ")。
<para>content</para>
用于诸如 <summary>、<remarks> 或 <returns> 等标记内,使您得以将段落添加到文本中。 
content:段落文本。
<list type="bullet" | "number" | "table">
<listheader>
<term>term</term>
<description>description</description>
</listheader>
<item>
<term>term</term>
<description>description</description>
</item>
</list>
<listheader> 块用于定义表或定义列表中的标题行。定义表时,只需为标题中的项提供一个项。 
列表中的每一项都用一个 <item> 块来描述。创建定义列表时,既需要指定 term 也需要指定 description。但是,对于表、项目符号列表或编号列表,只需为 description 提供一个项。 
列表或表所拥有的 <item> 块数可以根据需要而定。 
term:要定义的项,该项将在 description 中定义。 
description:项目符号列表或编号列表中的项或者 term 的定义。

注意:如果希望尖括号显示在文档注释的文本中,请使用 &lt; 和 &gt;。 例如,&lt;尖括号中的文本&gt;。

另外:可以在任意类型的注释块中增加一个 <namespace> 标记,其中可以包含各种常用注释标记,它们将被作为对当前类型的命名空间的批注。 
例如:

namespace MyNamespace {
/// <summary>
/// ...
/// </summary>
/// <namespace>
/// <summary>...</summary>
/// <remarks>...</remarks>
/// <example>...</example>
/// </namespace>
public class MyClass {
}
}
												
											

C# XML 文档注释的更多相关文章

  1. C# XML 文档注释文件格式

    在编写 C# 代码时,只要在注释按照格式加入 XML 文档注释,例如: /// <summary> /// 这里是类的注释. /// </summary> public cla ...

  2. 转 创建 JavaScript XML 文档注释

    http://www.cnblogs.com/chenxizhang/archive/2009/07/12/1522058.html 如何:创建 JavaScript XML 文档注释 Visual ...

  3. C#中XML文档注释编译DLL引用到其它项目

    引用地址:http://zhidao.baidu.com/link?url=jSGYEBysE4gBExtNsHCVk3vd2OK2cMlaf02cS79GdRuGueTBdFJB0btOdBYkg_ ...

  4. C#中的XML文档注释-推荐的文档注释标记

    文档注释是为了方便自己和他人更好地理解代码所实现的功能.下面记录了一些常用的文档注释标记: <C> 用法: <c>text</c> 将说明中的文本标记为代码.例如: ...

  5. 在Visual studio 2010中为C#的“///”注释内容生成XML文档 .

    实际上该方法适合于所有版本的Visual studio,方法很简单,设置一下Visual studio的项目属性和工具选项即可. 1.在菜单栏的“Project”中选择当前项目的“*** Proper ...

  6. C#反序列化XML异常:在 XML文档(0, 0)中有一个错误“缺少根元素”

    Q: 在反序列化 Xml 字符串为 Xml 对象时,抛出如下异常. 即在 XML文档(0, 0)中有一个错误:缺少根元素. A: 首先看下代码: StringBuilder sb = new Stri ...

  7. 将C#文档注释生成.chm帮助文档

    由于最近需要把以前的一个项目写一个文档,但一时又不知道写成怎样的,又恰好发现了可以生成chm的工具,于是乎我就研究了下,感觉还不错,所以也给大家分享下.好了,不多废话,下面就来实现一下吧. 生成前的准 ...

  8. 使用sp_xml_preparedocument处理XML文档

    有时会在存储过程中处理一些XML格式的数据,所以会用到sp_xml_preparedocument,他可以将XML数据进行读取,然后使用 MSXML 分析器 (Msxmlsql.dll) 对其进行分析 ...

  9. Eclipse 的快捷键以及文档注释、多行注释的快捷键

    一.多行注释快捷键 1.选中你要加注释的区域,用ctrl+shift+C 或者ctrl+/ 会加上//注释2.先把你要注释的东西选中,用shit+ctrl+/ 会加上/*    */注释 3.以上快捷 ...

随机推荐

  1. Daily Scrum - 12/04

    Meeting Minutes 与Qiufeng, Bojie, Zhongqiu, Ran, Travis一起讨论. 确定了最后的UI及Feature. 开始Code Review, 以及有计划的M ...

  2. [福大软工] Z班 团队作业——UML设计 作业成绩

    团队作业--UML设计 作业链接 http://www.cnblogs.com/easteast/p/7745703.html 作业要求 1)团队分工(5分) 描述团队的每个成员分别完成了UML图的哪 ...

  3. Win 2008 r2 远程桌面多用户登陆,一用户多登陆配置

    Windows 2008 R2远程桌面,设置最大连接数,一个登录后另一个就被踢掉等问题 Windows 2008 R2配置如图: 1.打开远程桌面回话主机配置 2.右键RDP-Tcp,属性,可设置最大 ...

  4. vue 请求后台数据2(copy)

    https://blog.csdn.net/vergilgeekopen/article/details/68954940 需要引用vue-resource 安装请参考https://github.c ...

  5. MT【98】三元对称不等式

    评:这是一道浙江省省赛题,这里利用对称性,设$x\le y\le z$从而解决了问题.值得注意的是此处三元轮换对称正好也是完全对称,但如果变成一般的$n\ge4$元对称问题时,就不能设大小关系.事实上 ...

  6. 【刷题】BZOJ 1823 [JSOI2010]满汉全席

    Description 满汉全席是中国最丰盛的宴客菜肴,有许多种不同的材料透过满族或是汉族的料理方式,呈现在數量繁多的菜色之中.由于菜色众多而繁杂,只有极少數博学多闻技艺高超的厨师能够做出满汉全席,而 ...

  7. How to 对拍?

    对拍从数学的统计学角度来说是一个好的方法,至少能在你竞赛中帮你拿回一些分--yzr大牛pas的对拍一开始还没写过,突然想学一下对拍.那么就学吧.dp水题(搜索):https://www.luogu.o ...

  8. 【hdu3842】 Machine Works

    http://acm.hdu.edu.cn/showproblem.php?pid=3842 (题目链接) 题意 一个公司使用一个厂房$D$天,希望获利最大.有$n$台机器,每一台可以在第$D_i$天 ...

  9. @RequestParam注解一般用法

    原文链接:https://www.cnblogs.com/likaileek/p/7218252.html SpringMVC注解@RequestParam全面解析   在此之前,写项目一直用的是@R ...

  10. 转头条:阿里p7架构师:三年经验应该具备什么样的技能?

    问:工作中,有时候实现一个功能,会去看有没有现成的轮子可用.对于重复造轮子与改造轮子有什么看法? 答:一定会的,其实这也是一个提高技术能力的方法,比如今天想做个日期转换的功能,JDK8有日期的新特性就 ...