【问题标题】:C# documentation – possible to add parent nodes inside namespace?C# 文档 – 可以在命名空间内添加父节点吗?
【发布时间】:2016-01-28 14:25:58
【问题描述】:

我正在记录一个由单个命名空间构建的 C# 项目,该命名空间包含 8 个接口、类和枚举。

我正在使用最新版本的沙堡(2015 年 7 月)。 由于所有接口、类和枚举都在同一个命名空间下,所以我在同一个 API 内容父节点下得到了所有的沙堡结果,这不是我想要的。 相反,我希望在一个父节点下拥有所有接口,在另一个父节点下拥有所有类,在另一个父节点下拥有所有枚举。另外(如果可能的话)我希望每个 API 父节点都有一个概念上的兄弟节点来描述概念。

有可能吗?如果没有,您能否提出其他解决方案? 请注意,我无法添加命名空间。

使用沙堡 - 是否可以使用几种内容布局,每个界面一个? (不确定是否可以为命名空间使用 1 个以上的内容布局)。

谢谢

【问题讨论】:

    标签: c# documentation sandcastle


    【解决方案1】:

    我找到了这个问题的解决方案,并决定分享,以防它对任何人有用。

    Sandcastle 不支持将 API 文档拆分为几个节点。所以我找到的解决方法是使用 HTML Workshop Manager 根据需要重新排列 HTML。只需在 HTML Workshop manager 中创建一个项目,并将其设置为使用 Sandcastle 生成的 HTML。注意 Sandcastle HTML 文件名只是数字,所以需要根据 html 内容以某种方式重命名。

    HTML Workshop Manager 具有命令行界面,因此从 Sandcastle 的 html 创建 CHM 的整个过程可以自动化。为此,您需要预先在 HTML Workshop manager 中创建一个项目,并编写代码来更新其目录(.hhc 文件)和索引文件(.hhk),以便它们使用 Sandcastle 的 HTML。我建议为此使用 HTML Agility 包,因为 .hhc 和 .hhk 文件是 html。

    评论将不胜感激。

    【讨论】:

      猜你喜欢
      • 2016-07-08
      • 1970-01-01
      • 2011-01-02
      • 2023-03-09
      • 1970-01-01
      • 2023-04-07
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多