如何将代码示例放在.NET XML注释中？

Question

我可以使用哪些标签将代码示例放入.NET /// XML注释中？

Answer 1

尝试使用<example>标记。

/// <example>
/// <code>
/// // create the class that does translations
/// GiveHelpTransforms ght = new GiveHelpTransforms();
/// // have it load our XML into the SourceXML property
/// ght.LoadXMLFromFile(
///  "E:\\Inetpub\\wwwroot\\GiveHelp\\GiveHelpDoc.xml");
/// </code>
/// </example>

我从here得到了上面的例子。

Answer 2

您可以使用<example>和<code>代码。

检查Recommended Tags for Documentation Comments。