网站输出中是否支持项目摘要？

Question

首先，SHFB岩石：-）

我使用独立帮助文件生成器和工具来呈现基于Web的“帮助站点”。 但是，指定的项目摘要似乎被忽略/忽略，并且在结果输出网站文件中从未找到。

有人可以告诉我如何在SHFB呈现的网站中包含项目摘要吗？

预先感谢

橡木人

Answer 1

简短的故事-仅在使用概念性主题时，项目摘要没有任何意义。

在记录代码库时，描述名称空间很重要。 XML文档注释不支持添加名称空间的摘要信息。但是，可以使用Sandcastle帮助文件生成器添加这些额外信息。

SHFB通过允许您手动向每个名称空间添加摘要来摆脱限制。此摘要存储在SHFB项目中，因此您不必在每次构建文档时都重新创建它。

有些名称空间可能需要在生成的帮助文件中添加一个根名称空间和注释作为节点。

如下所示，您需要设置一些选项并添加文本：

生成的CHM文件：