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

Question

이 질문은이 질문에서 비롯됩니다코드 문서는 얼마입니까?

답은 XML 문서를 별도의 파일로 유지하는 것이 었습니다. 나는 코드를 살펴볼 때 문서의 진실성이 성가신 것처럼 그 대답을 정말로 좋아했습니다. 반면에, Intellisense를 통해 올바른 방법을 검색하거나 문서를 게시 할 때는 진동성이 유용하다는 것을 알았습니다.

답은 포함 태그를 사용하는 것이 었습니다

/// <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 접두사 유형, 메소드, 필드.