XML 부분 클래스 / 메소드에 대한 설명

Question

는 부분 클래스에 XML 스타일의 주석을 갖는 API 문서 핸들을 생성하는 데 사용되는 도구가 사용하는 표준 방식이 있습니까?기본적으로 결과 도움말 문서가 삽입되지 않도록 부분 클래스 / 메소드를 어떻게 주석으로 주석 처리해야합니까?이 질문은 사용 된 도구에 따라 다를 수 있습니다.이 경우 가장 중요한 두 가지 도구가 다음과 같습니다.

• Visual Studio의 XML 문서를 작성하는 메소드
• Microsoft의 Sandcastle

  XML 문서가 나오기를 원하지 않습니다 펑키는 모두 입니다.

  /// <summary>Some Foo class</summary>
  public partial class Foo { ... }
  
  /// <summary>Some Foo class that implements some interface.</summary>
  public partial class Foo : ISomeInterface { ... }
  

  .

Answer 1

가장 좋은 방법은 XML의 코멘트를 의 단지 1에 제공하는 것입니다. public 댓글을 2 곳으로 분할 할 필요가 없어야합니다.(물론 정기적 인 코멘트는 여전히 각 부분 정의에 포함됩니다.)

Visual Studio 작동 방식은 한 부분 정의의 주석이 다른 부분 정의에있는 주석이 다른 부분보다 무시됩니다.다른 XML 주석을 가진 동일한 클래스의 2 부분 정의를 생성 한 다음이 유형의 변수를 작성 하여이 문제를 확인할 수 있습니다.IntelliSense는 XML 주석 중 1 개만 표시됩니다.

SandCastle이 포함 된 Visual Studio에서 생성 된 XML 주석 파일을 사용하는 문서 도구의 동작이됩니다.