メソッドまたはプロパティの型パラメータを汎用型の戻り値の型で文書化する方法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);