2011-11-30 2 views
2

기본 클래스가 아닌 서브 클래스의 이름을 반영하도록 설명서 주석을 업데이트하는 표준 방법이 있습니까? 또한, 방법이 존재한다면, 이것은 연습하거나 피하는 것이지요?Documentation Comments (Subclass)

예 : 문서는 구현 된 코드에 적용

class BaseClass 
{ 
    /// <summary> 
    /// Gets or sets a value associated with the name of the BaseClass 
    /// </summary> 
    protected string Name { get; set; } 
} 

class SubClass : BaseClass 
{ 
    /// Gets or sets a value associated with the name of the Subclass <-- updated 
    /// protected string Name { get; set; } <-- defined on BaseClass 
} 

답변

0

호 - 클래스는 기본 클래스에서 메서드를 상속하는 경우, 그 문서는 또한 상속됩니다. 새로운 구현을 제공하지 않으면 문서를 '재정의'할 수 없습니다. (구현이 변경되지 않은 경우에도 구현을 변경하지 않으면 변경되지 않아도됩니다.)

외부 양식이나 IntelliSense 형식으로 문서를 탐색하면 기본 클래스의 문서가 필요에 따라 표시되므로 적절한 문서를보기 위해 다시 정의 할 필요가 없습니다.

0

Sandcastle Help File Builder을 사용하는 경우 <inheritdoc/> tag을 사용하여 설명을 어느 정도 다시 사용할 수 있습니다. 예를 들어 기본 클래스에 요약을 설정하고 파생 클래스에서 <inheritdoc/>을 사용하여 동일한 것을 선택할 수 있습니다. 그러나이 동적으로 변경할 방법이 있다고 생각하지 않습니다 (예 : 클래스 이름 대체) – 전체 요약 텍스트를 상속 받거나 그렇지 않습니다.