일반 또는 반환 형식의 메서드 또는 속성에서 형식 매개 변수를 문서화하는 방법 Action 또는 Func

Question

매우 간단한 질문이 있습니다. xmldoc을 사용하여 일반 Action 또는 Func의 반환 유형이있는 메서드 또는 속성을 어떻게 문서화합니까? 예 :

/// <summary> 
/// Gets or sets the print method. Parameters: file, printer name??? 
/// </summary> 
/// <value> 
/// The print method. 
/// </value> 
public Action<string, string> PrintMethod { get; set; } 

이 경우 가장 좋은 방법은 무엇입니까?

Answer 1

이 작업의 매개 변수를 문서화해야하는 경우 Action<string, string> : 대신 사용자 지정 위임을 만들고 위임의 매개 변수를 문서화하십시오.

/// <summary> 
/// Gets or sets the print method. 
/// </summary> 
/// <value> 
/// The print method. 
/// </value> 
public FilePrintAction PrintMethod { get; set; } 

/// <summary> 
/// Represents a method for printing a file to a printer 
/// </summary> 
/// <parameter name="file">Path of the file to print</parameter> 
/// <parameter name="printerName">Name of the printer</parameter> 
public delegate void FilePrintAction(string file, string printerName);