Question

在c＃中记录类的Func属性的参数和返回的推荐方法是什么？ e.g。

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中的Intellisense不像对方法那样在属性上提供param或return标记;那些仍然是最适合使用的标签吗？

编辑：

因为我已经在xml-documentation on msdn中发现了任何有效的xml可用于标记的问题，所以我现在的想法是更简单地使用param和return标记;或者使用自定义标签并决定适当的命名？

Answer 1

我建议首先让您的代码更“友好”，而不是依赖于代码文档。考虑将返回类型更改为友好命名的委托。

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

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

Answer 2

属性不使用param，因为它们不接受参数 - 您需要使用typeparam作为通用参数。而不是returns，请使用value。

为Func属性创建xml文档的推荐方法是什么？

2 个答案: