【问题标题】:Generate XML documentation for private members为私有成员生成 XML 文档
【发布时间】:2009-01-06 02:25:45
【问题描述】:

有没有办法为私有成员生成 XML 文档?默认情况下它只为公共成员生成它,这对于已发布的代码是正确的,但对于仅在公司内部使用的代码是正确的。

【问题讨论】:

    标签: c# .net vb.net visual-studio-2008


    【解决方案1】:

    尝试使用GhostDoc

    【讨论】:

      【解决方案2】:

      我的建议是将 xml 文档与代码一起编写。不需要太多时间,而且我发现这种方法可以帮助我更好地组织代码结构。

      【讨论】:

      • 正确:工具生成的 XML 文档几乎从来没有用过。或者您认为带有“添加产品”(和 要添加的产品)的 XML 文档注释的方法 Add(Product p) 值得它的字节......?跨度>
      • (嗯...文档 cmets,而不是方法本身。Duh!)
      • 对于不知道该方法的人来说,愚蠢的评论会表明没有什么特别的;)。但是您的观点是正确的,有时 cmets 只是浪费时间和字节。
      【解决方案3】:

      对于 Sandcastle,这里给出了答案:Sandcastle not generating private methods docs (C#)

      (在 Sandcastle 中打开 DocumentPrivates。)

      【讨论】:

        猜你喜欢
        • 1970-01-01
        • 2014-09-13
        • 1970-01-01
        • 2019-02-07
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        相关资源
        最近更新 更多