2014-02-13 4 views
3

기본 클래스에서 메서드를 상속/재정의 할 때 동일한 XML 주석을 복제하지 못하도록하는 방법 (도구 등)이 있습니까?무시할 때 주석 유지

예 :

/// <summary> 
/// Represent a brand new object in .NET 
/// </summary> 
public class MyObject : Object 
{ 
    /// <summary> 
    /// Copy-Paste the same Xml comment 
    /// like in the base class is boring! 
    /// </summary> 
    /// <param name="obj">and params too!! ((</param> 
    /// <returns>this one too!!! (((</returns> 
    public override bool Equals(object obj) 
    { 
     return base.Equals(obj); 
    } 
} 
+1

이 기능을 사용하려면 sandcastle에서 라이브러리에 대한 참조가 필요합니다. 필자가 문서를 보았을 때 그 것이 맞는지 아닌지 확실하지 않다. 그것이 거래 차단기라면,'https : // github.com/pmacn/DocPlagiarizer'를 성숙시켜야 할 수도 있습니다. 빌드 프로세스의 일부로 의견을 복사하는 맞춤 빌드 작업입니다. 현재'기본 클래스 -> 하위 클래스 '가 아닌'인터페이스 -> 구현'만 수행하지만 풀 요청이나 보고서는 환영합니다. 경고 : 나는이 짐승을 만들었습니다. –

답변

7

나는 당신이 inheritdoc 찾고있는 생각 :

/// <inheritdoc /> 
public override bool Equals(object obj) 

이 예쁜 standard tag가 (그래서 인텔리이 exampple, 그것은을 지원하지 않을 수 있습니다)하지만, 그건 아니다 일반적으로 사용됩니다 - 특히 Sandcastle supports it.

4

도구를 찾는 경우 GhostDoc visual studio 용 확장 프로그램을 사용해보세요. 주석을 미리 생성하는 데 도움이되며 기본 클래스의 주석을 사용할 수 있습니다.

생성 된 주석은 일반 주석이므로 IntelliSense는이를 올바르게 지원하지만 기본 주석이 변경되면 마술처럼 업데이트되지 않습니다.