NDoc 用户指南   [回目录] NDoc 1.3

<code>

[此文档为预发布版本,在未来版本中有可能改变。]

<code> 标记指示将其内部的文本表示为代码样式,Block 标记,用于表示多行的代码块。

<code [lang="language"][escaped="true"]>content</code>

其中:

lang="language" [NDoc 扩充]
语言选择器,表示此代码块仅适用于某种编程语言。(可选)
escaped="true" [NDoc 扩充]
content 中含有 XML 子级,将它们视为代码的一部分。注意:content 仍然需要是格式完好的 XML。(可选)
content
将被表示为代码块的文本。

应用于

可用于其他 Section 标记或 Block 标记内部。

备注

使用 lang 属性表示语言选择器,标准的语言有: Visual Basic, C#, C++JScript。若代码块适用于多种语言,则用逗号隔开,比如“Visual Basic, C#, C++”。

escaped 为 true 时,其内部所有其他标记都被转义为代码块的一部分。

注意  content 内容必须是格式完好的 XML 注释。否则整个注释块可能被忽略或出错!!!

示例

下面示例中,因为 escaped="true",因此直接写入了要作为代码块的 XML 内容。 Note how, in the following comments, the xml text can entered verbatim because the escaped="true" attribute has been applied.

   [C#]
   /// <summary>
   /// Loads the XML.
   /// </summary>
   /// <example> The XML should have the following format.
   /// <code escaped="true">
   ///   <root>
   ///     <