코드와 별도의 문서

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() 
    { 
    } 
}