强大的文档生成工具Sandcastle Help File Builder

今天为了弄个代码文档折腾了2小时。。最后终于弄好了

Sandcastle Help File Builder 很好很强大呀

安装啥的就不废话了 看看帮助就行

基本上就是先装上 Sandcastle 还有 Visual Studio SDK 装上再装 Sandcastle Help File Builder 就好了

 

基本来说 第一次使用之后总会出现的问题就是

[Missing <summary> documentation for "N:****"]

这个问题是 namespace 的 summary 找不到

可是 Visual Studio 里边 又不让我们写 namespace 的 summary …

其实解决的办法有两个

1: 不显示 namespace summary

在 Sandcastle Help File Builder 的 Show Missing Tags 里把 ShowMissingNamespaces 弄成 False

2: 手动添加 namespace summary

很遗憾 这个只能在 Sandcastle Help File Builder 里完成

找到 Comments 下的 NamespaceSummaries 点一下它的值 然后再点一下右边出现的 ,,, 按钮

不明白可以看图

点进去之后会出现个对话框 选一个namespace 在下边写一个注解 选一个 写一个

比较迷惑人的就是 你选了下一个的时候 注解显示的还是上一个的。。

感觉会让人觉得不能一对一写注解 反正我是迷惑了很久。。

一个一个注解写好再按 close 就行了

再运行的话 错误就消失了