百度空间 | 百度首页 
 
查看文章
 
创建.NET帮助文档
2008年06月11日 星期三 13:30

老早之前就知道在VS2005中可以写XML形式的注释,并可以很容易的生成帮助文档,但从来借口自己练习小程序,没有实行过。虽然话说扬长避短,但终究要进步,不能总是重复先前,于是先试着怎么在.NET中由XML注释自动生成帮助文档。

帮助文档有类如MSDN的HTML形式和传统的CHM,微软提供的工具是Sandcastle。正好我发现了一篇十分欣赏的文章介绍:《Sandcastle入门:创建C#帮助文档》排版清晰,尊重版权,属于博客中的原创好文。可惜的是作者文中用的图片基本上都是引用,估计作者并没有亲自全部试验所有方法。

我测试了其中的数种方法全部没有成功,不管是第三方的GUI如Sandcastle Help File BuilderSandcastleGUIDocProject ,还是使用原始的命令行。Sandcastle Help File Builder 1.7版本要求使用Sandcastle   Version 2.4.10520,恰逢Sandcastle 从Codeplex迁移,害得我带Tor穿越GFW在这里搞到了最新版,结果还TMD版本不,shit!

    于是通过搜索,发现有人和我的经历相同,基本上也是在上述所谓流行的工具中徘徊失败, 最终使用所谓的Ndoc2007成功生成Proj.NET的帮助文档。说所谓是因为用Google搜索NDoc2007,并未发现官方的网页说明叫法之类的,可能是NDoc的非官方升级版?在About下显示仍旧是停止更新的NDoc 1.3.1 。反正支持.NET2.0,用起来是个好东西,我已经运用成功,这样子以后查询Proj.NET中函数的原型就方便多了。


    我花费了近乎一天的时间在试验这些工具,有时想想谁先告诉我哪个工具真正有用的工具,岂不是就省下了许多时间?好像公司里文档组肯定知晓这些多种工具的优劣,将来写代码的我们或许只需要写好XML注释即可,何必花费这个时间呢?呵呵,不想了,成功就好。


类别:ict_about | 添加到搜藏 | 浏览() | 评论 (6)
 
最近读者:
 
网友评论:
1
2008年06月11日 星期三 15:34 | 回复
呵呵` 顶顶啦~
 
2
2008年06月11日 星期三 16:35 | 回复
相比javadoc要强悍的多哦,呵呵
 
3
2008年06月11日 星期三 17:12 | 回复
不错,我已追溯原文细看,谢啦!学到点东西
 
4
2008年06月12日 星期四 10:20 | 回复
走技术不会一直要与写代码为伴把。 -_,-
 
5
2008年06月12日 星期四 11:13 | 回复
饭否,徐静蕾的艾~~~
 
6
2008年06月13日 星期五 19:50 | 回复
我也还不会用这个。。 2005的帮助文档我看了觉得头疼
 
发表评论:
姓 名:
网址或邮箱: (选填)
内 容:
验证码: 请点击后输入四位验证码,字母不区分大小写
      

     

©2009 Baidu