C#文档–可以在命名空间中添加父节点



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

我正在使用sandcastle的最后一个版本(2015年7月)。由于所有接口、类和enum都在同一个名称空间下,所以我在同一API内容父节点下获得的sandcastle结果都是相同的,这不是我想要的。相反,我希望所有接口在一个父节点下,所有类在另一个父结点下,所有枚举在另一父结点下。此外(如果可能的话),我希望每个API父节点都有一个概念上的同级节点,以描述概念。

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

有了sandcastle,是否可以使用几个内容布局,每个界面一个?(不确定是否可以为一个命名空间使用多个内容布局)。

感谢

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

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

HTML Workshop Manager有命令行界面,所以从Sandcastle的htmls创建CHM的整个过程可以自动化。为此,您需要提前在HTML Workshop manager中创建一个项目,并编写一段代码来更新其内容表(.hhc文件)和索引文件(.hhk),以便它们使用Sandcastle的HTML。我建议使用HTML敏捷包,因为.hhc和.hhk文件都是HTML。

将评估评论。

最新更新