함수 오버로드에 대한 일반적인 의견을 표시하는 방법

Question

일부 오버로드로 함수를 만들었습니다. 이제 각 오버로드에 대한 설명을 추가하고 요약 내용을 반복해서 반복하지 않으려합니다. 매개 변수 설명 만 제공하면됩니다. 여기

즉

/// <summary> 
    /// Binds Control With DataTable/DataSet Passed as a Parameter. DataTable/Control Should not be NULL. 
    /// </summary> 
    /// <param name="lbx">DropDownList control</param> 
    /// <param name="dt">Object of DataTable from where value need be fetched.</param> 
    /// <param name="displayMember">Display Member for the list</param> 
    public static void Source(this DropDownList ddl, DataTable dt, string displayMember) 
    { 
    // do something. 
    } 

    /// <summary> 
    /// Binds Control With DataTable/DataSet Passed as a Parameter. DataTable/Control 
    /// </summary> 
    /// <param name="lbx">DropDownList control</param> 
    /// <param name="dt">Object of DataTable from where value need be fetched.</param> 
    /// <param name="displayMember">Display Member for the list</param> 
    /// <param name="_setDefaultItem">If True Sets the default value as -1 and corresponding string</param> 
    public static void Source(this DropDownList ddl, DataTable dt, string displayMember, bool _setDefaultItem) 
    { 
    //do something 
    } 

나는 또 다시 요약 섹션을 작성하려는 해달라고하지만 매개 변수 부분 만에 대한 의견을 작성합니다. 모든 과부하에 대해 안주를 볼 수 있어야합니다.

할 방법이 있습니까?

Answer 1

이렇게하려면 include 태그를 사용할 수 있습니다.

오버로드 된 메서드의 일반적인 요약 매개 변수 설명을 사용하여 xml 파일을 만듭니다.

모든 오버로드 된 메서드에서이를 참조하고 오버로드 된 메서드에만 메서드 별 매개 변수 목록 주석을 추가하십시오.

/// <include file='common_tag.doc' path='MyDocs/MyMembers[@name="source"]/*' /> 
public static void Source(this DropDownList ddl, DataTable dt, string displayMember) 
{ 
// do something. 
} 

/// <include file='common_tag.doc' path='MyDocs/MyMembers[@name="source"]/*' /> 
/// <param name="_setDefaultItem">If True Sets the default value as -1 and corresponding string</param> 
public static void Source(this DropDownList ddl, DataTable dt, string displayMember, bool _setDefaultItem) 
{ 
//do something 
} 

그리고 UR XML 파일 내가 테스트하지 않았습니다

<MyDocs> 

<MyMembers name="source"> 
<summary> 
Binds Control With DataTable/DataSet Passed as a Parameter. DataTable/Control Should not be NULL 
</summary> 
<param>....</param> 
</MyMembers> 


</MyDocs> 

같은이 ...이

을 시도 할 수있다