多应用+插件架构,代码干净,二开方便,首家独创一键云编译技术,文档视频完善,免费商用码云13.8K 广告
# 建议的文档注释标记(C# 编程指南) C# 编译器处理代码中的文档注释,将它们设置为 XML 文件格式,其文件名在 **/doc** 命令行选项中指定。若要创建基于编译器生成的文件的最终文档,您可以创建自定义工具,也可以使用诸如等工具 [约定](http://shfb.codeplex.com/)。 在代码构造(如类型和类型成员)上处理标记。 | ![](https://box.kancloud.cn/2016-01-31_56adb62c1380a.jpg) 注意 | | :-- | | 文档注释不能应用于命名空间。 | 编译器将处理任何为有效 XML 的标记。下列标记提供了用户文档中常用的功能。 ## 标记 | [&lt;c&gt;](https://msdn.microsoft.com/zh-cn/library/te6h7cxs.aspx) | [&lt;para&gt;](https://msdn.microsoft.com/zh-cn/library/x640hcd2.aspx) | [&lt;see&gt;](https://msdn.microsoft.com/zh-cn/library/acd0tfbe.aspx)* | |:--- |:--- |:--- | | [&lt;code&gt;](https://msdn.microsoft.com/zh-cn/library/f8hahtxf.aspx) | [&lt;param&gt;](https://msdn.microsoft.com/zh-cn/library/8cw818w8.aspx)* | [&lt;seealso&gt;](https://msdn.microsoft.com/zh-cn/library/xhd7ehkk.aspx)* | | [&lt;example&gt;](https://msdn.microsoft.com/zh-cn/library/9w4cf933.aspx) | [&lt;paramref&gt;](https://msdn.microsoft.com/zh-cn/library/wb7x2fhw.aspx) | [&lt;summary&gt;](https://msdn.microsoft.com/zh-cn/library/2d6dt3kf.aspx) | | [&lt;exception&gt;](https://msdn.microsoft.com/zh-cn/library/w1htk11d.aspx)* | [&lt;permission&gt;](https://msdn.microsoft.com/zh-cn/library/h9df2kfb.aspx)* | [&lt;typeparam&gt;](https://msdn.microsoft.com/zh-cn/library/ms173191.aspx)* | | [&lt;include&gt;](https://msdn.microsoft.com/zh-cn/library/9h8dy30z.aspx)* | [&lt;remarks&gt;](https://msdn.microsoft.com/zh-cn/library/3zw4z1ys.aspx) | [&lt;typeparamref&gt;](https://msdn.microsoft.com/zh-cn/library/ms173192.aspx) | | [&lt;list&gt;](https://msdn.microsoft.com/zh-cn/library/y3ww3c7e.aspx) | [&lt;returns&gt;](https://msdn.microsoft.com/zh-cn/library/4dcfdeds.aspx) | [&lt;value&gt;](https://msdn.microsoft.com/zh-cn/library/azda5z79.aspx) | (* 表示编译器验证语法。) 如果想要尖括号出现在文档注释文本中,使用 &lt; 和 &gt;。如下面示例所示。 <a>XML</a> ``` /// <summary cref="C &lt; T &gt;"> /// </summary> ``` ## 请参阅 [C# 编程指南](https://msdn.microsoft.com/zh-cn/library/67ef8sbd.aspx) [/doc (C# Compiler Options)](https://msdn.microsoft.com/zh-cn/library/3260k4x7.aspx) [XML 文档注释(C# 编程指南)](https://msdn.microsoft.com/zh-cn/library/b2s063f7.aspx)