單獨的文檔從代碼

Question

我不知道這是否是可能的，但我不知道是否有保持代碼和單獨的文件中的文件的方式，但仍然工作一樣，因爲它與聯文檔一般不會。

Answer 1

是的，您可以將XML文檔註釋保存在外部文件中，並使用<include>標記將它們包含在您的代碼文件中。

從the MSDN documentation：

標籤可以讓你指的是另一個文件中描述的類型和成員在你的源代碼註釋。這是將文檔註釋直接放在源代碼文件中的替代方法。通過將文檔放在單獨的文件中，可以將源代碼控制與源代碼分開使用。一個人可以簽出源代碼文件，其他人可以簽出文檔文件。

例如，你可能有一個名爲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() 
    { 
    } 
}