コードと別個の文書

Question

コードと文書を別々のファイルに保存する方法があるかどうかは分かりませんが、通常はインライン文書と同じように動作しますか？

Answer 1

はい、XMLドキュメントのコメントを外部ファイルに保存し、<include>タグを使用してコードファイルに含めることができます。 the MSDN documentationから

：

タグは、あなたのソースコード内の型とメンバーを記述し、別のファイル内のコメントを参照することができます。これは、ソースコードファイルにドキュメンテーションコメントを直接配置する代わりの方法です。ドキュメントを別のファイルに置くことで、ソースコードとは別にドキュメントにソースコントロールを適用することができます。 1人の人がソースコードファイルをチェックアウトし、誰かがドキュメントファイルをチェックアウトすることができます。

例えば

、次のドキュメンテーションコメントを含む、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() 
    { 
    } 
}