메소드 설명에 대한 XML 주석을 별도의 파일에 보관하려면 어떻게해야합니까?

Question

이 질문은 Code documentation how much is too much?

한 답변은 별도의 파일에 XML 문서를 유지했다이 질문에 유래한다. 나는 코드를보고있을 때 문서를 자세히 볼 때 짜증나는 반면, 인텔리 센스 (intellisense)를 통해 올바른 방법을 찾거나 문서를 게시 할 때는 자세한 정보가 유용하다는 점에서 그 대답을 정말 좋아했습니다.

답은이 (가) 내가 요약 정보를 유지하는 방법을 알아 냈 here.

태그를 포함에 대해

/// <include file="Documentation/XML/YourClass.xml" path="//documentation/members[@name='YourClass']/*"/> 

또한 MSDN 문서가 태그를 포함 사용했지만, 나도 몰라 메서드 설명서를 거기에 넣는 방법도 찾을 수 없었습니다. (이 클래스 요약 자체보다 더 중요하다.

Answer 1

대답은 간단합니다. 생성 된 XML 파일을 읽기. 그들은 분리 된 XML 파일의 모습 방법 아이디어를 제공합니다.

을 생성 XML 파일을 읽고 방법 .

<member name="M:BitFactory.Logging.Logger.DoLog(BitFactory.Logging.LogEntry)"> 
    <summary> 
    Really log aLogEntry. (We are past filtering at this point.) 
    Subclasses might want to do something more interesting and override this method. 
    </summary> 
    <param name="aLogEntry">The LogEntry to log</param> 
    <returns>true upon success, false upon failure.</returns> 
</member> 

T, M, F 프리픽스 유형, 메소드, 필드

: 방법 (파라미터 등으로) 설명