【问题标题】:Document Internal Class with Sandcastle使用 Sandcastle 记录内部类
【发布时间】:2015-04-09 17:02:51
【问题描述】:

在我的 C# 项目中,SHFB 不包括内部类的描述,尽管它们之前有 <summary></summary> 元素。这些类甚至出现在类列表中,但描述是空白的。

我已启用内部成员的可见性,但无法弄清楚如何启用内部类。有什么想法吗?

在 VS2013 Ultimate 中开发,使用来自 NuGet 的最新 SHFB 版本 (2014.11.22.0)。

(我知道有些人会质疑我为什么要包含内部成员的文档,但事实证明,快速参考代码库对我们的开发团队很有用。)

【问题讨论】:

  • 启用 SHFB 2015.1.12.0 和“内部成员”文档后,我得到了课程摘要。 (NuGet 可能没有最新的,我从github.com/EWSoftware/SHFB/releases 得到我的)。您可能还想检查相关程序集的最新 XML 文档是否已针对正确的项目配置构建。
  • 我启用了“内部成员”。我将检查 xml 文档并下载新版本的 SHFB。
  • 更新到 2015.1.12.0。问题依然存在。
  • 想通了!我没有启用 XML 输出。感谢您的建议!

标签: c# sandcastle shfb


【解决方案1】:

在@softwariness 的帮助下,我解决了这个问题。

  1. 打开“项目属性”
  2. 选择“构建”标签。
  3. 在“输出”下,启用“XML 文档文件:”

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2017-08-14
    • 1970-01-01
    • 2019-12-04
    • 2014-05-20
    • 1970-01-01
    • 1970-01-01
    • 2016-08-18
    • 2011-08-07
    相关资源
    最近更新 更多