3

在 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 中的 Intellisense 不像为方法提供的那样在属性上提供参数或返回标记；这些仍然是最合适的标签吗？

编辑：

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

4

2 回答 2

4

我建议不要依赖代码文档，而是从使您的代码对“最终开发人员”更友好开始。考虑将返回类型更改为友好命名的委托。

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

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

于 2012-07-14T08:16:39.873 回答
0

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

于 2012-07-14T08:11:26.147 回答