C# 如何随方法一起记录方法的属性?
是否可以将属性信息与方法文档一起包含在生成的xml文档中 例如,此代码:C# 如何随方法一起记录方法的属性?,c#,xml,documentation,comments,C#,Xml,Documentation,Comments,是否可以将属性信息与方法文档一起包含在生成的xml文档中 例如,此代码: /// <summary> /// This is a summary. /// </summary> /// <param name="s"></param> /// <returns></returns> [MyAttribute("one", "two", "three")] pub
/// <summary>
/// This is a summary.
/// </summary>
/// <param name="s"></param>
/// <returns></returns>
[MyAttribute("one", "two", "three")]
public string MyMethod(string s)
{
throw new NotImplementedException();
}
将在XML文档中生成类似的内容:
<member name="M:MyNameSpace.MyMethod(System.String)">
<summary>
This is a summary.
</summary>
<param name="s"></param>
<returns></returns>
</member>
<member name="M:MyNameSpace.MyMethod(System.String)">
<attributes>
<attribute name="MyAttribute">
<param name="one"/>
<param name="two"/>
<param name="three"/>
</attribute>
</attributes>
<summary>
This is a summary.
</summary>
<param name="s"></param>
<returns></returns>
</member>
有没有办法在XML文档中获得类似的内容:
<member name="M:MyNameSpace.MyMethod(System.String)">
<summary>
This is a summary.
</summary>
<param name="s"></param>
<returns></returns>
</member>
<member name="M:MyNameSpace.MyMethod(System.String)">
<attributes>
<attribute name="MyAttribute">
<param name="one"/>
<param name="two"/>
<param name="three"/>
</attribute>
</attributes>
<summary>
This is a summary.
</summary>
<param name="s"></param>
<returns></returns>
</member>
提前感谢所有的答案 不确定。但是阅读下面的内容 你应该可以得到
<member name="M:MyNameSpace.MyMethod(System.String)">
<attribute name="MyAttribute" values = "1,2,3">
</attribute>
<summary>
This is a summary.
</summary>
<param name="s"></param>
<returns></returns>
</member>
利用
///<attribute name="MyAttribute" values="1,2,3"></attribute>
从中你可以看到:
编译器将处理任何有效XML标记
所以我想你想要的是可以做到的可能是重复的,我不想用属性来装饰文档,但事实正好相反。我也在尝试记录属性,以及方法、属性、类等。属性对于诸如Sandcastle之类的文档工具来说不是有效的标记。我确信你是对的,但我只是回答了一个问题:如何生成XML。XML可能不是设计为与Sandcastley一起运行的,您可能希望在回答中提到这一点。