C#通用類Helper整理

★前言

    最近下載了tita_chou在CSDN上傳的一個資源,是在工作中整理的C#幫助類,裏面包含了很多實用的類,想到我之前收集過自己用到少的可憐的類,心生敬意啊。當粗略的查看了那個資源,發現有一些是重複的,有一些我的裏面有的那個沒有,於是乎就萌生了重新整理一個屬於自己的幫助類,於是乎就花了幾個晚上的時間,重新過了一遍,還借用SandCastle工具生成了幫助文檔(CHM),這一個開源的工具,感覺生成幫助文檔挺方便的,下面會介紹這個工具。

★爲什麼要整理

     爲什麼要整理這個幫助類呢,其實我也不太清楚,可能跟我有收藏的愛好有關吧,說起我的收藏,歷史淵源啊……其實我感覺這樣做的一個好處是,就是減少重複造輪子或者找輪子的重複勞動。以前在寫代碼中經常遇到一個似曾相識的功能,好像在哪做過,但又想不起來,於是就開始翻以前寫的代碼,翻來翻去,好不容易找到了感覺是上帝的恩賜似的,趕緊複製粘貼過來,也有不少時候找不到在哪,於是一狠心一跺腳重寫一遍吧!浪費了很多時間,說不定還被追債,很是不爽,所以就有了這個通用庫,以後可以多花點時間在自己的核心業務上了,這樣說來還是有必要的,我相信很多朋友都有類似整理的習慣吧。

★整理過程

   整個過程也沒有用到多少技術,整個過程還是輕鬆愉快的,並接觸到了新的東西,已經很滿足了,在這裏簡單的記錄一下整理的過程:

   1、合併功能重複的類;

   2、完善類的註釋;

   3、精簡冗餘代碼;

   4、利用SandCastle工具生成幫助文檔,不熟悉SandCastle可以參考這裏,關於.NET中的XML註釋規則參考這裏張子秋前輩已經寫的很詳細了,受益匪淺,生成的CHM文檔地址在這裏

   5、源碼上傳到Github,在這裏,同時上傳的還有使用SandCastle創建的生成幫助文檔的項目,使用的方法主要參考這裏

   6、利用Windows Live Writer寫這篇博客,第一次用,感覺還不錯,主要是可以離線寫博文,不會因爲網絡問題引起數據丟失(想起來之前用網頁編輯器,一不小心就沒了,都是淚啊),參考在這裏

★整理成果

下面就是這幾天整理的成果,CHM文件目錄的截圖,看起來成果頗豐啊,不過裏面的東西還是慘不忍睹啊(還有很大部分不太完善):

2014-10-22_232256

★總結

  雖然花了幾個晚上看電影的時間,不過感覺這工作挺值了,以後或多或少會用的到吧,尤其是學會使用SandCastle生成幫助文檔和Live Writer寫博客了(大神勿笑)。不過在整理的過程中也看到了自己還是很無知啊,很多東西都沒弄明白,總以爲進入這行也有兩年左右也有不少經驗了,但現在的水平也就剛入門吧,以後還有很長一段路要走啊。

★聲明及願景

   此項目中的代碼是基於tita_chou上傳的資源的加工及進一步整理,尊重原作者的版權,若涉及侵權,請聯繫刪除源碼。不過我還是希望大家能夠共同完善這個項目,現在還有很多不完善的地方,包括註釋不全,大部分代碼都沒經過測試,也存在很多功能重複的地方,期待您的加入,讓我們一起把這個代碼庫做的更強大,源碼在這裏!!!

★問題

WIN7下,Helper幫助文檔.chm,打開後點擊列表,無法顯示內容
1.存放路徑中不能有中文,你試試直接放在類似D盤下,看看能正常顯示不
2.參考:http://jingyan.baidu.com/article/6f2f55a19f6f97b5b93e6c9d.html

 

★參考

下面列出文章中沒有提到的參考

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

http://www.veryhuo.com/a/view/71066.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

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章