代码改变世界

VS2010之Sandcastle help file builder 创建C#chm 文档

2012-02-14 16:32  Chan08  阅读(522)  评论(0)    收藏  举报

    这几天整理公司底层方法手写文档确实相当麻烦,于是看是否有对应的生成工具....

    结果是肯定的,不然就没这篇文章了...

    首选下载SHFB(全称Sandcastle help file builder):

    微软的东东那就Codeplex上去找:

    http://shfb.codeplex.com/       

    然后再下载HTML Help Workshop(其实就是一个生成chm的工具):

    http://msdn2.microsoft.com/en-us/library/ms669985.aspx

    生成一个专业的C#技术文档以上两个工具足够(前提是你XML注释要写得专业)

    安装完毕:

    1:打开SHFB

    2:新建项目--快捷键ctrl+n  作为一个程序员手动创建项目过程我就不说了

    3:选择属性:

         

  比较懒直接上图  呵呵

  这些属性我相信都能看懂    上面黑体是我配置的属性  需要什么配置什么就行了

  4:

   打开VS把要用到的项目右键--属性--生成--勾选XML输出如图:

   

5:生成项目

6:继续看到你的SHFB

 在右边的Documentation Sources节点上右键:

 添加上有关项目的dll文件【话说:动态链接库】如图:

 

 如果你注意看你会发现有个xml文件 它就是第4步那位xml文件  他的重要性不必说了,如果你持怀疑态度你删了试试就知道了,反正我没试过   呵呵

 7:

  看清楚了!! 只点一个按钮:

  它就在工具栏上看着你

  8:回家抱妹子吧...还写什么文档啊...想些都写不了....

   很简单的...没那么复杂...

  另外如果你注释写得不规范那我个人觉得你还是先去学学很简单:

  先去瑶姐那取点经:http://hi.baidu.com/czlaner/blog/item/aa9251d35e7005033af3cfce.html

  嗯......还有个问题就是上面没提到SHFB怎么加入图片    因为这个我也不知道时间紧迫暂时花不了那么多时间,我网上也没收到

  如果哪位使用过SHFB加入图片麻烦给我说下...呵呵...

  技术嘛越分享越高端...