Question

I have a very simple question, how would you document with xmldoc a method or a property with return type of generic Action or Func.
For example:

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

Which is the best practices in this case?

Answer 1

If you need to document the parameters of this action, don’t use Action<string, string>: create a custom delegate instead, and document the parameters of the delegate.

/// <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);