如何为 Func 属性创建推荐的 XML 文档？

Question

在C#中，如何记录类上的Func属性的参数和返回值是推荐的方式？ 例如：

public class Test
{
    /// <summary>
    /// A description of what AFunc is for.
    /// </summary>
    /// <remarks>
    /// Should I document the parameters and return here or somewhere else?
    /// </remarks>
    public Func<object, string[], bool> AFunc { get; set; }
}

在Visual Studio 2010中，智能感知不会像方法一样在属性上提供param或return标签; 但这些标签仍然是最合适的吗？

编辑：

自从我问了这个问题后，在msdn上的一些xml文档中发现任何有效的xml都可以用来标记，所以我现在的想法更多地是要么简单地使用param和return标签；要么使用自定义标签并决定适当的命名？

- Alternator

Answer 1

与其依赖于代码文档，我建议您从使您的代码更加“最终开发人员”友好的角度出发。考虑将返回类型更改为友好命名的委托。

http://msdn.microsoft.com/en-us/library/ms173171(v=vs.100).aspx

首先，这将使您的代码更加自我解释。然后，您可以使用代码文档来解释返回值的目的，而不是尝试解释返回值的类型。

- Paul Fleming

---

我认为这实际上就是我想要的。但是为了澄清，我已经用一个被定义为public delegate bool MyFuncType(object MyFirstParam, string[] MySecondParam)的委托替换了Func<object, string[], bool>。 - Alternator

Answer 2

属性不使用参数，因为它们不需要参数 - 您需要使用 typeparam 来处理泛型参数。不要使用 returns，而是使用 value。

- Jason Williams

---

属性不使用参数，因为它们不需要参数 - 这是正确的，但委托确实需要，并且他特别指的是一个 Func 类型的属性。 - Konrad Morawski

他正在尝试将Func<>用作属性，这是委托的特定实现，它始终返回一个值并且被广泛使用。 - kerzek

@kerzek, Morawski; 正确。根据上面flem的回答和我读到的其他内容，看起来我应该使用明确定义的委托，并针对该定义进行文档编写。 - Alternator