将文档与代码分开

本文关键字：代码 文档 | 更新日期: 2023-09-27 18:28:02

我不知道这是否可能，但我想知道是否有一种方法可以将代码和文档保存在单独的文件中，但仍然可以像通常使用内联文档一样工作。

将文档与代码分开

是的，您可以将XML文档注释保存在外部文件中，并使用<include>标记将其包含在代码文件中。

来自MSDN文档：

标记允许您引用另一个文件中的注释，这些注释描述源代码中的类型和成员。这是将文档注释直接放在源代码文件中的一种替代方法。通过将文档放在一个单独的文件中，可以将源代码管理与源代码分开应用于文档。一个人可以签出源代码文件，其他人可以签出文档文件。

例如，您可能有一个名为xml_include_tag.doc的文件，其中包含以下文档注释：

<MyDocs>
    <MyMembers name="test">
        <summary>
            The summary for this type.
        </summary>
    </MyMembers>
    <MyMembers name="test2">
        <summary>
            The summary for this other type.
        </summary>
    </MyMembers>
</MyDocs>

您可以将此文档包含在代码文件中，如下所示：

/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test"]/*' />
class Test
{
    static void Main()
    {
    }
}
/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test2"]/*' />
class Test2
{
    public void Test()
    {
    }
}
相关文章：