版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請進行舉報或認領
文檔簡介
軟件項目實踐補充內(nèi)容團隊項目開發(fā)編碼規(guī)范{}團隊項目開發(fā)"編碼規(guī)范"之一:概述
為什么要制定編碼規(guī)范:第一、能代碼更加易于維護,程序并不是一次性的產(chǎn)品,它需要擴展和修改還有維護的。但是進行這次操作的人并一定就是你了,所以你為了你的接班人也要將規(guī)范編碼進行到底!第二、可以提高代碼質(zhì)量,誰編程都不是一次性完成的,是需要不斷的測試與調(diào)試,以各種狀態(tài)來修改自己的代碼,而將代碼規(guī)范化,就能對程序本身有更加清晰的結(jié)構(gòu)思路,從而減少調(diào)試而成為快捷高效的代碼。第三、也是最為重要的,是將你本身個性化溶于團隊化的過程,當你熟練運用編碼規(guī)范了,就等于在以后的職場的道路上更加寬廣。編碼規(guī)范是一種習慣,一開始習慣不養(yǎng)好,永遠寫不出工程型代碼。{}團隊項目開發(fā)“編碼規(guī)范”之二:代碼外觀1、列寬代碼列寬控制在110字符左右。2、換行當表達式超出或即將超出規(guī)定的列寬,遵循以下規(guī)則進行換行
1)在逗號后換行;2)在操作符前換行;3)規(guī)則1優(yōu)先于規(guī)則2。3、縮進縮進應該是每行一個Tab(4個空格),不要在代碼中使用Tab字符。
{}團隊項目開發(fā)“編碼規(guī)范”之二:代碼外觀4、空行空行是為了將邏輯上相關(guān)聯(lián)的代碼分塊,以便提高代碼可閱讀性。在代碼中,不能包含多個空行。在以下情況下使用一個空行
1)方法與方法、屬性與屬性之間。
2)方法中變量聲明與語句之間。
3)方法與方法之間。
4)方法中不同的邏輯塊之間。
5)方法中的返回語句與其他的語句之間。
6)屬性與方法、屬性與字段、方法與字段之間。
7)注釋與它注釋的語句間不空行,但與其他的語句間空一行。
{}團隊項目開發(fā)“編碼規(guī)范”之二:代碼外觀5、
空格在以下情況中要使用到空格
1)關(guān)鍵字和左括符“(”應該用空格隔開。如while(true)
注意:在方法名和左括符“(”之間不要使用空格,這樣有助于辨認代碼中的方法調(diào)用與關(guān)鍵字。
2)多個參數(shù)用逗號隔開,每個逗號后都應加一個空格。3)除了.之外,所有的二元操作符都應用空格與它們的操作數(shù)隔開。一元操作符、++及--與操作數(shù)間不需要空格。如:a+=c+d;a=(a+b)/(c*d);4)語句中的表達式之間用空格隔開。如
for(expr1;expr2;expr3)
{}團隊項目開發(fā)“編碼規(guī)范”之二:代碼外觀6、花括號-{}1)左花括號“{”放于關(guān)鍵字或方法名的下一行并與之對齊。如if(condition){}
2)左花括號“{”要與相應的右花括號“}”對齊。
3)通常情況左花括號“{”單獨成行,不與任何語句并列一行。4)if、while、do語句后一定要使用{},即使只有一條語句。如
if(somevalue==1){somevalue=2;}{}團隊項目開發(fā)“編碼規(guī)范”之二:代碼外觀6、花括號-{}5)右花括號“}”后建議加一個注釋以便于方便的找到與之相應的{。如
while(1){if(valid){}else{}//if}//while{}團隊項目開發(fā)“編碼規(guī)范”之三:程序注釋1、注釋概述1)在每個例程的開始,提供標準的注釋樣本以指示例程的用途、假設和限制很有幫助。注釋樣本應該是解釋它為什么存在和可以做什么的簡短介紹。2)避免在代碼行的末尾添加注釋;行尾注釋使代碼更難閱讀。不過在批注變量聲明時,行尾注釋是合適的。3)避免在塊注釋的周圍加上印刷框。這樣看起來可能很漂亮,但是難于維護。4)在部署發(fā)布之前,移除所有臨時或無關(guān)的注釋,以避免在日后的維護工作中產(chǎn)生混亂。{}團隊項目開發(fā)“編碼規(guī)范”之三:程序注釋1、注釋概述5)在編寫注釋時使用完整的句子。注釋應該闡明代碼,而不應該增加多義性。6)在編寫代碼時就注釋,因為以后很可能沒有時間這樣做。7)為了防止問題反復出現(xiàn),對錯誤修復和解決方法代碼總是使用注釋,尤其是在團隊環(huán)境中。8)在所有的代碼修改處加上修改標識的注釋。9)用空白將注釋同注釋分隔符分開。在沒有顏色提示的情況下查看注釋時,這樣做會使注釋很明顯且容易被找到。{}團隊項目開發(fā)“編碼規(guī)范”之三:程序注釋2、
文件注釋在每個文件頭必須包含以下注釋說明//<copyrightfile="文件名.cs"company="HP">//Copyright(c)HP.Allrightsreserved.//</copyright>//<author>×××</author>//<date>yyyy-mm-dd</date>//<summary>文件功能描述</summary>//<modify>//修改人:×××//修改時間:yyyy-mm-dd//修改描述:×××//版本:1.0//</modify>{}團隊項目開發(fā)“編碼規(guī)范”之三:程序注釋3、文檔型注釋1)類、接口注釋///<summary>///類功能的說明///</summary>///<seecref=""></see>///<remarks>///創(chuàng)建人:Zhangsan///創(chuàng)建日期:yyyy-mm-dd///修改人:Lisi///修改日期:yyyy-mm-dd///修改備注:無///版本:1.0///</remarks>{}團隊項目開發(fā)“編碼規(guī)范”之三:程序注釋3、文檔型注釋2)方法、事件注釋///<summary>///根據(jù)員工編號獲得員工信息
///</summary>///<paramname="employeeId">員工編號</param>///<exceptioncref="System.Exception">系統(tǒng)異常</exception>///<returns>員工姓名</returns>///<remarks>///創(chuàng)建人:Zhangsan///創(chuàng)建日期:yyyy-mm-dd///修改人:Lisi///修改日期:yyyy-mm-dd///修改備注:無
///版本:1.1///</remarks>{}團隊項目開發(fā)“編碼規(guī)范”之三:程序注釋3、文檔型注釋2)方法、事件注釋///<summary>///根據(jù)員工編號獲得員工信息
///</summary>///<paramname="employeeId">員工編號</param>///<exceptioncref="System.Exception">系統(tǒng)異常</exception>///<returns>員工姓名</returns>///<remarks>///創(chuàng)建人:Zhangsan///創(chuàng)建日期:yyyy-mm-dd///修改人:Lisi///修改日期:yyyy-mm-dd///修改備注:無
///版本:1.1///</remarks>{}團隊項目開發(fā)“編碼規(guī)范”之四:聲明1、每行聲明數(shù)一行只作一個聲明,如
intlevel;//推薦
intsize;//推薦
intx,y;//不推薦2、初始化建議在變量聲明時就對其做初始化。3、位置變量建議置于塊的開始處,不要總是在第一次使用它們的地方做聲明。{}團隊項目開發(fā)“編碼規(guī)范”之五:命名規(guī)范1、命名概述名稱應該說明“什么”而不是“如何”。提供人們可以理解的名稱。1)避免容易被主觀解釋的難懂的名稱,如方面名AnalyzeThis(),或者屬性名xx8。這樣的名稱會導致多義性。2)在變量名中使用互補對,如min/max、begin/end和open/close。3)布爾變量名應該包含Is,這意味著Yes/No或True/False值,如fileIsFound。4)即使對于可能僅出現(xiàn)在幾個代碼行中的生存期很短的變量,仍然使用有意義的名稱。僅對于短循環(huán)索引使用單字母變量名,如i或j。{}團隊項目開發(fā)“編碼規(guī)范”之五:命名規(guī)范1、命名概述5)用名詞或名詞詞組來給類型命名,在少數(shù)情況下也可以用形容詞詞組來給類型命名6)用動詞或動詞詞組來命名方法7)用名詞、名詞詞組或形容詞來命名屬性8)要用動詞或動詞短語來命名事件9)要用名詞或名詞短語來命名字段2、Pascal大小寫將標識符的首字母和后面連接的每個單詞的首字母都大寫??梢詫θ址蚋嘧址臉俗R符使用Pascal大小寫。例如:BackColor{}團隊項目開發(fā)“編碼規(guī)范”之五:命名規(guī)范3、控件命名1)
命名方法控件名簡寫+英文描述,英文描述首字母大寫2)
主要控件名簡寫對照表控件名簡寫控件名簡寫LabellblTextBoxtxtButtonbtnLinkButtonlnkbtnImageButtonimgbtnDropDownListddlListBoxlstDataGriddgDataListdlCheckBoxchkCheckBoxListchklsRadioButtonrdoRadioButtonListrdoltImageimgPanelpnlCalendercldAdRotatorarTabletblRequiredFieldValidatorrfvCompareValidatorcvRangeValidatorrvRegularExpressionValidatorrevValidatorSummaryvsCrystalReportViewerrptvew{}團隊項目開發(fā)“編碼規(guī)范”之五:命名規(guī)范3、控件命名1)
命名方法控件名簡寫+英文描述,英文描述首字母大寫2)
主要控件名簡寫對照表控件名簡寫控件名簡寫LabellblTextBoxtxtButtonbtnLinkButtonlnkbtnImageButtonimgbtnDropDownListddlListBoxlstDataGriddgD
溫馨提示
- 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
- 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
- 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會有圖紙預覽,若沒有圖紙預覽就沒有圖紙。
- 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
- 5. 人人文庫網(wǎng)僅提供信息存儲空間,僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護處理,對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對任何下載內(nèi)容負責。
- 6. 下載文件中如有侵權(quán)或不適當內(nèi)容,請與我們聯(lián)系,我們立即糾正。
- 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。
最新文檔
- 大自然奇妙探險
- 創(chuàng)意之光:用廢舊材料動手制作一件藝術(shù)品
- 小學學科測試練習題目資料
- 小學綜合實踐模擬試卷
- 2024-2030年全球與中國異丁基溴溶液市場供需趨勢及發(fā)展價值研究報告
- 大學語文(第五版)課件 第十五講 古代思想?道家和佛教
- 小學語文作文微課教育課件
- 煤機煤機輸送設備生產(chǎn)線建設項目資金申請報告
- 財務總監(jiān)實驗心得體會
- 2024年學校衛(wèi)生室工作總結(jié)范文(5篇)
- 安全生產(chǎn)獎勵與處罰制度
- 變頻器變頻altivar71說明書
- 精密工程控制測量復測成果報告
- 人民幣知識介紹_ppt
- abb繼電保護615系列操作手冊
- 尾礦庫在線監(jiān)測方案
- 《放射物理與防護》第九章
- 中信銀行擔保機構(gòu)管理辦法(共10頁)
- TROXLER3440核子密度儀
- 人員花名冊表格
- 2流動人員人事檔案轉(zhuǎn)遞通知單存根
評論
0/150
提交評論