从代码中分离文档

Question

我不知道是否可能,但我想知道是否有办法将代码和文档保存在单独的文件中,但仍然与通常使用内联文档相同.

Answer 1

是的,您可以将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()
    {
    }
}