如何记录方法的属性以及方法?

时间:2015-01-21 17:13:44

标签: c# xml documentation comments

是否可以在生成的xml文档中包含属性信息以及方法的文档?

例如,此代码:

    /// <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>

我有什么方法可以在XML文档中得到这样的东西:

    <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>

提前感谢所有答案!

1 个答案:

答案 0 :(得分:0)

不确定。但阅读以下内容

https://msdn.microsoft.com/en-us/library/b2s063f7.aspx

你应该能够

<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>

来自https://msdn.microsoft.com/en-us/library/5ast78ax.aspx您可以阅读:

  

编译器将处理任何有效XML的标记。

所以我猜你想做什么