C# 为Func属性创建xml文档的推荐方法是什么
在c中记录类的参数和Func属性返回的推荐方法是什么# e、 gC# 为Func属性创建xml文档的推荐方法是什么,c#,properties,func,xml-documentation,C#,Properties,Func,Xml Documentation,在c中记录类的参数和Func属性返回的推荐方法是什么# e、 g 公共类测试 { /// ///对AFunc的用途的描述。 /// /// ///我应该记录参数并返回这里还是其他地方? /// 公共函数AFunc{get;set;} } VisualStudio2010中的Intellisense不像方法那样在属性上提供param或return标记;但是,这些仍然是最合适的标签吗 编辑: 自从提出这个问题以来,我在一些文章中发现任何有效的xml都可以用来标记,所以我现在的想法更倾向于简
公共类测试
{
///
///对AFunc的用途的描述。
///
///
///我应该记录参数并返回这里还是其他地方?
///
公共函数AFunc{get;set;}
}
VisualStudio2010中的Intellisense不像方法那样在属性上提供param或return标记;但是,这些仍然是最合适的标签吗
编辑:
自从提出这个问题以来,我在一些文章中发现任何有效的xml都可以用来标记,所以我现在的想法更倾向于简单地使用param和return标记;或者使用自定义标记并决定适当的命名?属性不使用param,因为它们不接受参数-您需要使用
typeparam
作为泛型参数。不要使用返回值
,而是使用值
而不是依赖代码文档,我建议从让代码更“最终开发人员”友好开始。考虑将返回类型更改为友好命名委托。
首先,这将使您的代码更易于解释。然后,您可以使用代码文档来解释返回值的用途,而不是试图解释返回值的类型。
属性不使用param,因为它们不接受参数
-这是正确的,但委托接受,他具体指的是Func
tyoe属性他试图将Func用作属性,这是委托的一个特定实现,它总是返回一个值,并且被广泛使用。@kerzek,Morawski;对的从上面弗莱姆的回答和我读到的更多东西来看;听起来我实际上应该使用一个明确定义的委托和文档来反对这个定义。我想这就是我想要的。但为了澄清,我将Func
替换为定义为public delegate bool MyFuncType(object MyFirstParam,string[]MySecondParam)
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; }
}