【问题标题】:How to document the method's attributes along with the method?如何将方法的属性与方法一起记录?
【发布时间】:2015-03-20 07:33:04
【问题描述】:

是否可以在生成的 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>

提前感谢所有答案!

【问题讨论】:

标签: c# xml documentation comments


【解决方案1】:

不确定。但是阅读以下内容

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 标记。

所以我猜你想要什么都可以完成

【讨论】:

  • "attribute" 不是 Sandcastle 等文档工具的有效标签。
  • 我确定你是对的,但我只是回答了这个问题:“如何生成 XML”。 XML 可能未设计为与 SandCastle 一起运行
  • 您可能想在回答中提及这一点。
猜你喜欢
  • 2019-01-27
  • 2017-07-16
  • 2022-01-16
  • 1970-01-01
  • 2021-08-24
  • 2011-06-01
  • 1970-01-01
  • 1970-01-01
  • 2011-04-05
相关资源
最近更新 更多