前言:前兩天肥老家啦涕蚤,本來想著要休息幾天,啥事兒不干混吃混喝等開學万栅,奈何家里有個賢內(nèi)助,鼓勵我寫文章烦粒,說指著我的文章入門.net休溶,嘎嘎嘎。雖然至今為止貌似也沒啥童鞋來圍觀撒遣,但是堅持就是勝利嘛义黎。
相信大家看到過不少別人寫的程序,有的程序注釋很好廉涕,程序文檔組織很清晰狐蜕,程序的說明也很詳細明了宠纯,大大提高了程序的可復用婆瓜、可維護性贡羔;有的程序則讓人一看就決定自己重寫算了,這就是程序規(guī)范的重要性猴蹂。
今天這篇文章主要說說我們組使用的一個C#工程框架楣嘁,感覺還是比較清晰明了的珍逸。我們老師每天跟我們強調(diào)文檔的規(guī)范谆膳、程序注釋的規(guī)范勤婚,想出來好幾套(包括MCU微控制器程序框架、C#工程框架馒胆、Web工程框架等)清晰的工程文件的組織方式(即工程框架)祝迂,細節(jié)到文檔的命名。我們使用了3-4年型雳,覺得還是很不錯的纠俭,后期維護和修改挺方便。今天這篇文章說的就是我們老師安利給我們的C#工程框架朴则,遵照這個框架來安排程序钓简,會比較有條理喲。
提綱:給出一個比較清晰明了的C#工程框架撤蚊,及自定義修改工程框架的方法损话。
一丧枪、C#工程框架
為了有序更好的學習C#,并且在后期的實際項目中顶捷,代碼組織更清晰合理屎篱,非常有必要搭建一個好的工程框架。下表是推薦的一個C#工程框架:
二、按照框架從頭組織一個程序
我們使用上一篇文章給出的Hello World程序開始秦士,按照給出的C#工程框架隧土,重新組織一下文檔和程序。下圖就是組織之前的工程:
1.新建工程文件夾
(1)在項目工程名上右擊->添加->新建文件夾
(2)在新建的文件夾上右擊->重命名辐脖,修改成表格中給出的名字皆愉,如“01-Doc”幕庐。
按照這種方法异剥,創(chuàng)建如圖的6個文件夾:
PS:為啥給文件夾編號呢?-編號之后错妖,文件夾的順序就定下來啦疚沐,打開程序所在文件夾,看到的也是一樣的順序痴施。
2.將相應的程序文件移動到相應文件夾
工程框架在第一步就算是建好了究流,下面我們要將相應的文件芬探,放到對應的文件夾中。
(1)在要移動的程序或文件上右擊->剪切偷仿;在目標文件夾上右擊->粘貼。這樣节榜,工程中的文件就移動到相應的文件夾下面啦宗苍。比如Form,是窗口文件讳窟,就移動到02-Form丽啡,即窗體文件夾之中。
文件移動完成之后,就如上圖馏予。目前工程非常簡單霞丧,沒有很多使用到的類庫、只有一個窗體蛹尝、沒有數(shù)據(jù)庫突那、工程圖片、用戶自定義控件等早龟。到后期猫缭,工程復雜起來就可以看到使用這個工程框架的好處≈ゼ樱看別人的程序射窒,或者后期修改老赤,一般是先看說明文件制市,就在01-Doc中祥楣。C#工程最直觀的是窗體汉柒,雙擊即可進入響應程序,放在了工程第二位兽间,有多個窗體的時候正塌,不用在雜亂的程序文件中掃描,直接在02-Form中找帜羊,其他文件亦然鸠天。要注意的是,后期文件按照文章開頭的表格組織文件奶段,對應擺放剥纷。
3.在文件夾中添加文件
我們常常需要在建好的工程框架中新建晦鞋、添加文件。
(1)添加已有文件吼砂;例如在工程中添加一個程序說明文檔readme.docx.程序說明文檔將會放在01-Doc中鼎文。我們在工程目錄下01-Doc文件夾中,新建一個readme.docx:
新建完之后周偎,在VS程序框架中還是看不見這個文件的蓉坎,需要如下操作:
在目標文件夾上右擊->添加->現(xiàn)有項
默認只能看見C#類型文件,需要改成所有文件钳踊,如下圖:
選中要添加的文件拓瞪,點擊添加:
(2)在工程下新建一個程序文件助琐,以添加一個類文件為例:
在目標文件上右擊->添加->類:
選擇要添加的文件類型兵钮,此處添加一個類:選中類->修改文件名稱->點擊添加:
添加之后掘譬,會自動填寫好此類型文件的相關代碼如下:(這個類后期是作為全局變量聲明的地方)
4.添加完成的工程框架
編輯完成之后的工程框架如下圖:
后期我們添加窗體屁药、類等程序或文件時,應當遵守文章開頭給出的表格复亏,將相應的程序放到相應的位置缭嫡,方便后續(xù)的閱讀、修改耕突。
5.readme文檔的寫法
程序說明文檔對于看程序的人來說评架,非常重要。要想別人更好的理解你寫的程序上祈,使用你的程序,我們就應當好好重視這一塊內(nèi)容的書寫籽腕;下圖是一個推薦的程序說明文檔的結(jié)構(gòu)示意纸俭。后續(xù)給出的實驗程序,均可到01-Doc文件夾中查看程序說明文檔郎楼。
希望大家都能寫出功能強大女轿,而又規(guī)范易懂的程序蛉迹,造福社會放妈。少一些看不懂、難重用的垃圾程序珍策,多一些可讀性強宅倒、高可復用、可移植的優(yōu)質(zhì)程序蹭劈,一起加油啦线召!