★前言
最近下载了tita_chou在CSDN上传的一个资源,是在工作中整理的C#帮助类,里面包含了很多实用的类,想到我之前收集过自己用到少的可怜的类,心生敬意啊。当粗略的查看了那个资源,发现有一些是重复的,有一些我的里面有的那个没有,于是乎就萌生了重新整理一个属于自己的帮助类,于是乎就花了几个晚上的时间,重新过了一遍,还借用SandCastle工具生成了帮助文档(CHM),这一个开源的工具,感觉生成帮助文档挺方便的,下面会介绍这个工具。
★为什么要整理
为什么要整理这个帮助类呢,其实我也不太清楚,可能跟我有收藏的爱好有关吧,说起我的收藏,历史渊源啊……其实我感觉这样做的一个好处是,就是减少重复造*或者找*的重复劳动。以前在写代码中经常遇到一个似曾相识的功能,好像在哪做过,但又想不起来,于是就开始翻以前写的代码,翻来翻去,好不容易找到了感觉是上帝的恩赐似的,赶紧复制粘贴过来,也有不少时候找不到在哪,于是一狠心一跺脚重写一遍吧!浪费了很多时间,说不定还被追债,很是不爽,所以就有了这个通用库,以后可以多花点时间在自己的核心业务上了,这样说来还是有必要的,我相信很多朋友都有类似整理的习惯吧。
★整理过程
整个过程也没有用到多少技术,整个过程还是轻松愉快的,并接触到了新的东西,已经很满足了,在这里简单的记录一下整理的过程:
1、合并功能重复的类;
2、完善类的注释;
3、精简冗余代码;
4、利用SandCastle工具生成帮助文档,不熟悉SandCastle可以参考这里,关于.NET中的XML注释规则参考这里,张子秋前辈已经写的很详细了,受益匪浅;
5、源码上传到Github,在这里,同时上传的还有使用SandCastle创建的生成帮助文档的项目,使用的方法主要参考这里;
6、利用Windows Live Writer写这篇博客,第一次用,感觉还不错,主要是可以离线写博文,不会因为网络问题引起数据丢失(想起来之前用网页编辑器,一不小心就没了,都是泪啊),参考在这里。
★整理成果
下面就是这几天整理的成果,CHM文件目录的截图,看起来成果颇丰啊,不过里面的东西还是惨不忍睹啊(还有很大部分不太完善):
★总结
虽然花了几个晚上看电影的时间,不过感觉这工作挺值了,以后或多或少会用的到吧,尤其是学会使用SandCastle生成帮助文档和Live Writer写博客了(大神勿笑)。不过在整理的过程中也看到了自己还是很无知啊,很多东西都没弄明白,总以为进入这行也有两年左右也有不少经验了,但现在的水平也就刚入门吧,以后还有很长一段路要走啊。
★声明及愿景
此项目中的代码是基于tita_chou上传的资源的加工及进一步整理,尊重原作者的版权,若涉及侵权,请联系我删除源码。不过我还是希望大家能够共同完善这个项目,现在还有很多不完善的地方,包括注释不全,大部分代码都没经过测试,也存在很多功能重复的地方,期待您的加入,让我们一起把这个代码库做的更强大,源码在这里!!!
★参考
下面列出文章中没有提到的参考
SandCastle参考:
http://blog.csdn.net/yl2isoft/article/details/18454115
http://www.cnblogs.com/net515/p/3311584.html
http://www.cnblogs.com/zhangziqiu/archive/2009/01/31/1381666.html
Windows Live Writer参考:
http://www.cnblogs.com/lyj/archive/2008/11/30/1344463.html
http://www.cnblogs.com/cmt/archive/2012/06/25/2560793.html
http://www.cnblogs.com/cmt/archive/2012/06/26/live_writer_cnblogs_entryname.html
http://www.cnblogs.com/cmt/archive/2012/06/26/live_writer_cnblogs_code_highlight.html