在 X# 中,您可以将 XML 元素包含在源代码中的特殊注释字段(用三斜线表示)中,直接放在注释指向的代码块之前,为代码创建文档。
/// <summary>
/// 该类具有一项重要功能。
/// </summary>
CLASS MyClass
.
.
END CLASS
使用 -doc 选项编译时,编译器会搜索源代码中的所有 XML 标记,并创建一个 XML 文档文件。要根据编译器生成的文件创建最终文档,可以创建自定义工具或使用 Sandcastle 等工具。
要引用 XML 元素(例如,您想在 XML 文档注释中描述的函数处理特定 XML 元素),您可以使用标准引号机制(< 和 >)。要引用代码引用 (cref) 元素中的通用标识符,可以使用转义字符(例如,cref=“List<T>”)或大括号(cref=“List{T}”)。作为一种特殊情况,编译器会将大括号解析为角括号,以便在引用通用标识符时减少文档注释的编写麻烦。
由于我们使用与 C# 相同的文档引擎,因此允许使用的文档标记 可参考 C# 文档 。