C# XML 주석 재사용

Question

저는 거의 동일한 기능을 수행하는 여러 클래스가있는 C# 클래스 라이브러리를 작성하고 있습니다. 대부분의 경우에 매우 상세하지만 각 클래스의 함수 인수에 대한 XML 주석을 제공해야합니다. XML 주석을 재사용 할 수있는 방법이 있습니까? 그렇기 때문에 이러한 XML 인수 정의를 어셈블리 전체에서 반복 할 필요가 없습니까?

public class IsodoseControl : TestModule 
{ 
    /// <summary> 
    /// Verify a control on Isodose dialog 
    /// </summary> 
    /// <param name="args"> **<-- WHAT I DON'T WANT TO KEEP REPEATING** 
    /// Arguments: [Property, Condition, Expected Value, Tolerance] 
    ///   Properties: STATE, VALUE, LABEL 
    ///   Conditions: Exists, DoesNotExist, IsEnabled, IsDisabled, ... 
    ///   Expected Value (optional): blah blah 
    ///   Tolerance (optional): blah blah blah 
    /// </param> 
    public VerifResult VerifyIsodoseControl(string[] args) 
    { 
     ... 
    } 
} 

public class BeamControl : TestModule 
{ 
    /// <summary> 
    /// Verify a control on Beam dialog 
    /// </summary> 
    /// <param name="args"> **<-- WHAT I DON'T WANT TO KEEP REPEATING** 
    /// Arguments: [Property, Condition, Expected Value, Tolerance] 
    ///   Properties: STATE, VALUE, LABEL 
    ///   Conditions: Exists, DoesNotExist, IsEnabled, IsDisabled, ... 
    ///   Expected Value (optional): blah blah 
    ///   Tolerance (optional): blah blah blah 
    /// </param> 
    public VerifResult VerifyBeamControl(string[] args) 
    { 
     ... 
    } 
} 

감사

Answer 1

내가 당신을 도울 것입니다 Visual Studio에서 아무것도 생각하지 않습니다

여기 내 수업의 예입니다. Sandcastle는 XML 주석의 전체 블록을 상속하게됩니다 태그, inheritdoc을 가지고, 또는 당신은 또한 특별히 설계되었습니다 당신이

/// <summary> 
/// Verify a control on Beam dialog 
/// </summary> 
/// <param name="args"><token>CommonParamInfo</token></param> 
/// (...) 

샌드캐슬 같은 것을 쓸 수 것입니다 귀하의 PARAM 텍스트가 포함 된 모래 token을 정의 할 수 있습니다 API 문서를 위해, 그리고 귀하의 사건에 적절하지 않을 수도 있습니다.

Answer 2

당신은> < 포함 태그를 사용하여 두 클래스에서 같은 파일을 참조 할 수는 "<> 태그는 당신이 당신의 소스 코드의 형식과 멤버를 설명하는 다른 파일의 주석을 참조 할 수 있습니다. 포함".

/// <include file='comments.xml' path='MyDocs/MyMembers[@name="test"]/*' /> 
class OneClass {} 

/// <include file='comments.xml' path='MyDocs/MyMembers[@name="test"]/*' /> 
class DifferentClassWithTheSameFunctionality {} 

이 링크는 <를 사용하는 몇 가지 예는 제공> : http://msdn.microsoft.com/en-us/library/9h8dy30z.aspx