C# 文档——可以在命名空间内添加父节点吗?
C# documentation – possible to add parent nodes inside namespace?
我正在记录一个由包含 8 个接口、classes 和枚举的单个命名空间构建的 C# 项目。
我使用的是最新版本的 sandcastle(2015 年 7 月)。
由于所有接口、class 和枚举都在同一个命名空间下,因此我得到的沙堡结果都在同一个 API 内容父节点下,这不是我想要的。
相反,我希望所有接口都在一个父节点下,所有 classes 在另一个父节点下,所有枚举都在另一个父节点下。此外(如果可能的话)我希望每个 API 父节点都有一个概念兄弟节点来描述概念。
可能吗?如果没有,你能建议其他解决方案吗?
请注意,我无法添加命名空间。
使用 sandcastle - 是否可以使用一些内容布局,每个界面一个? (不确定是否可以为命名空间使用 1 个以上的内容布局)。
谢谢
我找到了这个问题的解决方案,并决定分享,以防万一它对任何人都有用。
Sandcastle 不支持将 API 文档分解为几个节点。所以我找到的解决方法是使用 HTML Workshop Manager 根据需要重新排列 HTMLs。只需在 HTML Workshop Manager 中创建一个项目,并将其设置为使用 Sandcastle 生成的 HTMLs。注意Sandcastle HTML 文件名仅为数字,因此需要根据html 内容以某种方式重命名。
HTML Workshop Manager 具有命令行界面,因此从 Sandcastle 的 htmls 创建 CHM 的整个过程可以自动化。为此,您需要在 HTML Workshop manager 中预先创建一个项目,并编写代码来更新其 table 的内容(.hhc 文件)和索引文件(.hhk),以便他们使用 Sandcastle 的 HTML秒。我建议为此使用 HTML 敏捷包,因为 .hhc 和 .hhk 文件是 htmls.
评论将被赞赏。
我正在记录一个由包含 8 个接口、classes 和枚举的单个命名空间构建的 C# 项目。
我使用的是最新版本的 sandcastle(2015 年 7 月)。 由于所有接口、class 和枚举都在同一个命名空间下,因此我得到的沙堡结果都在同一个 API 内容父节点下,这不是我想要的。 相反,我希望所有接口都在一个父节点下,所有 classes 在另一个父节点下,所有枚举都在另一个父节点下。此外(如果可能的话)我希望每个 API 父节点都有一个概念兄弟节点来描述概念。
可能吗?如果没有,你能建议其他解决方案吗? 请注意,我无法添加命名空间。
使用 sandcastle - 是否可以使用一些内容布局,每个界面一个? (不确定是否可以为命名空间使用 1 个以上的内容布局)。
谢谢
我找到了这个问题的解决方案,并决定分享,以防万一它对任何人都有用。
Sandcastle 不支持将 API 文档分解为几个节点。所以我找到的解决方法是使用 HTML Workshop Manager 根据需要重新排列 HTMLs。只需在 HTML Workshop Manager 中创建一个项目,并将其设置为使用 Sandcastle 生成的 HTMLs。注意Sandcastle HTML 文件名仅为数字,因此需要根据html 内容以某种方式重命名。
HTML Workshop Manager 具有命令行界面,因此从 Sandcastle 的 htmls 创建 CHM 的整个过程可以自动化。为此,您需要在 HTML Workshop manager 中预先创建一个项目,并编写代码来更新其 table 的内容(.hhc 文件)和索引文件(.hhk),以便他们使用 Sandcastle 的 HTML秒。我建议为此使用 HTML 敏捷包,因为 .hhc 和 .hhk 文件是 htmls.
评论将被赞赏。