Step by step:一起來學C# (3)

前言:前兩天肥老家啦涕蚤,本來想著要休息幾天,啥事兒不干混吃混喝等開學万栅,奈何家里有個賢內(nèi)助,鼓勵我寫文章烦粒,說指著我的文章入門.net休溶,嘎嘎嘎。雖然至今為止貌似也沒啥童鞋來圍觀撒遣,但是堅持就是勝利嘛义黎。

相信大家看到過不少別人寫的程序,有的程序注釋很好廉涕,程序文檔組織很清晰狐蜕,程序的說明也很詳細明了宠纯,大大提高了程序的可復用婆瓜、可維護性贡羔;有的程序則讓人一看就決定自己重寫算了,這就是程序規(guī)范的重要性猴蹂。

今天這篇文章主要說說我們組使用的一個C#工程框架楣嘁,感覺還是比較清晰明了的珍逸。我們老師每天跟我們強調(diào)文檔的規(guī)范谆膳、程序注釋的規(guī)范勤婚,想出來好幾套(包括MCU微控制器程序框架、C#工程框架馒胆、Web工程框架等)清晰的工程文件的組織方式(即工程框架)祝迂,細節(jié)到文檔的命名。我們使用了3-4年型雳,覺得還是很不錯的纠俭,后期維護和修改挺方便。今天這篇文章說的就是我們老師安利給我們的C#工程框架朴则,遵照這個框架來安排程序钓简,會比較有條理喲。

提綱:給出一個比較清晰明了的C#工程框架撤蚊,及自定義修改工程框架的方法损话。


嘎嘎嘎

一丧枪、C#工程框架

為了有序更好的學習C#,并且在后期的實際項目中顶捷,代碼組織更清晰合理屎篱,非常有必要搭建一個好的工程框架。下表是推薦的一個C#工程框架:


工程框架文件組織


按照工程框架組織程序及文檔

二、按照框架從頭組織一個程序

我們使用上一篇文章給出的Hello World程序開始秦士,按照給出的C#工程框架隧土,重新組織一下文檔和程序。下圖就是組織之前的工程:

Hello World程序

1.新建工程文件夾

(1)在項目工程名上右擊->添加->新建文件夾

新建文件夾

(2)在新建的文件夾上右擊->重命名辐脖,修改成表格中給出的名字皆愉,如“01-Doc”幕庐。

文件夾重命名1
文件夾重命名2

按照這種方法异剥,創(chuàng)建如圖的6個文件夾:

創(chuàng)建文件夾

PS:為啥給文件夾編號呢?-編號之后错妖,文件夾的順序就定下來啦疚沐,打開程序所在文件夾,看到的也是一樣的順序痴施。

2.將相應的程序文件移動到相應文件夾

工程框架在第一步就算是建好了究流,下面我們要將相應的文件芬探,放到對應的文件夾中。

(1)在要移動的程序或文件上右擊->剪切偷仿;在目標文件夾上右擊->粘貼。這樣节榜,工程中的文件就移動到相應的文件夾下面啦宗苍。比如Form,是窗口文件讳窟,就移動到02-Form丽啡,即窗體文件夾之中。

文件移動1
文件移動2
文件移動3

文件移動完成之后,就如上圖馏予。目前工程非常簡單霞丧,沒有很多使用到的類庫、只有一個窗體蛹尝、沒有數(shù)據(jù)庫突那、工程圖片、用戶自定義控件等早龟。到后期猫缭,工程復雜起來就可以看到使用這個工程框架的好處≈ゼ樱看別人的程序射窒,或者后期修改老赤,一般是先看說明文件制市,就在01-Doc中祥楣。C#工程最直觀的是窗體汉柒,雙擊即可進入響應程序,放在了工程第二位兽间,有多個窗體的時候正塌,不用在雜亂的程序文件中掃描,直接在02-Form中找帜羊,其他文件亦然鸠天。要注意的是,后期文件按照文章開頭的表格組織文件奶段,對應擺放剥纷。

3.在文件夾中添加文件

我們常常需要在建好的工程框架中新建晦鞋、添加文件。

(1)添加已有文件吼砂;例如在工程中添加一個程序說明文檔readme.docx.程序說明文檔將會放在01-Doc中鼎文。我們在工程目錄下01-Doc文件夾中,新建一個readme.docx:

新建文件

新建完之后周偎,在VS程序框架中還是看不見這個文件的蓉坎,需要如下操作:

在目標文件夾上右擊->添加->現(xiàn)有項

添加文件1

默認只能看見C#類型文件,需要改成所有文件钳踊,如下圖:

添加文件2

選中要添加的文件拓瞪,點擊添加:

添加文件3

(2)在工程下新建一個程序文件助琐,以添加一個類文件為例:

在目標文件上右擊->添加->類:

添加程序文件1

選擇要添加的文件類型兵钮,此處添加一個類:選中類->修改文件名稱->點擊添加:

添加程序文件2

添加之后掘譬,會自動填寫好此類型文件的相關代碼如下:(這個類后期是作為全局變量聲明的地方)

添加程序文件3

4.添加完成的工程框架

編輯完成之后的工程框架如下圖:

工程框架

后期我們添加窗體屁药、類等程序或文件時,應當遵守文章開頭給出的表格复亏,將相應的程序放到相應的位置缭嫡,方便后續(xù)的閱讀、修改耕突。

5.readme文檔的寫法

程序說明文檔對于看程序的人來說评架,非常重要。要想別人更好的理解你寫的程序上祈,使用你的程序,我們就應當好好重視這一塊內(nèi)容的書寫籽腕;下圖是一個推薦的程序說明文檔的結(jié)構(gòu)示意纸俭。后續(xù)給出的實驗程序,均可到01-Doc文件夾中查看程序說明文檔郎楼。

程序說明文檔

希望大家都能寫出功能強大女轿,而又規(guī)范易懂的程序蛉迹,造福社會放妈。少一些看不懂、難重用的垃圾程序珍策,多一些可讀性強宅倒、高可復用、可移植的優(yōu)質(zhì)程序蹭劈,一起加油啦线召!

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末缓淹,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子料仗,更是在濱河造成了極大的恐慌伏蚊,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,427評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件肺孵,死亡現(xiàn)場離奇詭異,居然都是意外死亡吓肋,警方通過查閱死者的電腦和手機瑰艘,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,551評論 3 395
  • 文/潘曉璐 我一進店門紫新,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人囤耳,你說我怎么就攤上這事偶芍。” “怎么了椎麦?”我有些...
    開封第一講書人閱讀 165,747評論 0 356
  • 文/不壞的土叔 我叫張陵观挎,是天一觀的道長段化。 經(jīng)常有香客問我,道長普气,這世上最難降的妖魔是什么佃延? 我笑而不...
    開封第一講書人閱讀 58,939評論 1 295
  • 正文 為了忘掉前任履肃,我火速辦了婚禮,結(jié)果婚禮上封锉,老公的妹妹穿的比我還像新娘。我一直安慰自己碾局,他們只是感情好奴艾,可當我...
    茶點故事閱讀 67,955評論 6 392
  • 文/花漫 我一把揭開白布蕴潦。 她就那樣靜靜地躺著,像睡著了一般忽冻。 火紅的嫁衣襯著肌膚如雪此疹。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,737評論 1 305
  • 那天振诬,我揣著相機與錄音衍菱,去河邊找鬼脊串。 笑死清钥,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的缕坎。 我是一名探鬼主播篡悟,決...
    沈念sama閱讀 40,448評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼搬葬,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了急凰?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,352評論 0 276
  • 序言:老撾萬榮一對情侶失蹤乔外,失蹤者是張志新(化名)和其女友劉穎锭碳,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體推汽,經(jīng)...
    沈念sama閱讀 45,834評論 1 317
  • 正文 獨居荒郊野嶺守林人離奇死亡歹撒,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,992評論 3 338
  • 正文 我和宋清朗相戀三年诊胞,在試婚紗的時候發(fā)現(xiàn)自己被綠了撵孤。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,133評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡裕菠,死狀恐怖闭专,靈堂內(nèi)的尸體忽然破棺而出影钉,到底是詐尸還是另有隱情,我是刑警寧澤平委,帶...
    沈念sama閱讀 35,815評論 5 346
  • 正文 年R本政府宣布廉赔,位于F島的核電站,受9級特大地震影響浪册,放射性物質(zhì)發(fā)生泄漏岗照。R本人自食惡果不足惜笆环,卻給世界環(huán)境...
    茶點故事閱讀 41,477評論 3 331
  • 文/蒙蒙 一躁劣、第九天 我趴在偏房一處隱蔽的房頂上張望库菲。 院中可真熱鬧,春花似錦鳖擒、人聲如沸烫止。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,022評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽播赁。三九已至吼渡,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間舟奠,已是汗流浹背房维。 一陣腳步聲響...
    開封第一講書人閱讀 33,147評論 1 272
  • 我被黑心中介騙來泰國打工咙俩, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留湿故,地道東北人。 一個月前我還...
    沈念sama閱讀 48,398評論 3 373
  • 正文 我出身青樓脖阵,卻偏偏與公主長得像命黔,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子悍募,可洞房花燭夜當晚...
    茶點故事閱讀 45,077評論 2 355

推薦閱讀更多精彩內(nèi)容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,185評論 25 707
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理洋魂,服務發(fā)現(xiàn)喜鼓,斷路器,智...
    卡卡羅2017閱讀 134,671評論 18 139
  • 提綱: (1)C#的編程環(huán)境介紹 (2)C#的幾個語言要素 (3)第一個C#的窗體程序 一址晕、編程環(huán)境 C#的編程使...
    長肉肉呱閱讀 769評論 1 6
  • 風飄逸著 帶來了一場漫漫的秋雨 太陽躲進灰色的云層 很久沒有看見她的微笑啦 ...
    米瀾盛若閱讀 206評論 0 1
  • 2017年除了《伯德小姐》拿獎拿到手軟之外牢撼,還有一部電影同樣在各大獎項中斬獲豐收,更是在前不久的“金球獎”上提名六...
    阿貓家的一條狗閱讀 639評論 0 3