團隊項目開發(fā)編碼規(guī)范

1、 為什么要制定編碼規(guī)范： 第一、能代碼更加易于維護，程序并不是一次性的產(chǎn)品，它需要擴展和修改還有維護的。但是進行這次操作的人并一定就是你了，所以你為了你的接班人也要將規(guī)范編碼進行到底！ 第二、可以提高代碼質(zhì)量，誰編程都不是一次性完成的，是需要不斷的測試與調(diào)試，以各種狀態(tài)來修改自己的代碼，而將代碼規(guī)范化，就能對程序本身有更加清晰的結(jié)構(gòu)思路，從而減少調(diào)試而成為快捷高效的代碼。 第三、也是最為重要的，是將你本身個性化溶于團隊化的過程，當你熟練運用編碼規(guī)范了，就等于在以后的職場的道路上更加寬廣。編碼規(guī)范是一種習(xí)慣，一開始習(xí)慣不養(yǎng)好，永遠寫不出工程型代碼。1、列寬代碼列寬控制在110字符左右。2、換行

2、當表達式超出或即將超出規(guī)定的列寬，遵循以下規(guī)則進行換行 1）在逗號后換行; 2）在操作符前換行; 3）規(guī)則1優(yōu)先于規(guī)則2。 3、縮進 縮進應(yīng)該是每行一個Tab(4個空格)，不要在代碼中使用Tab字符。 4 、空行 空行是為了將邏輯上相關(guān)聯(lián)的代碼分塊，以便提高代碼可閱讀性。 在代碼中，不能包含多個空行。 在以下情況下使用一個空行 1）方法與方法、屬性與屬性之間。 2）方法中變量聲明與語句之間。 3）方法與方法之間。 4）方法中不同的邏輯塊之間。 5）方法中的返回語句與其他的語句之間。 6）屬性與方法、屬性與字段、方法與字段之間。 7）注釋與它注釋的語句間不空行，但與其他的語句間空一行。 5、 空

3、格 在以下情況中要使用到空格 1）關(guān)鍵字和左括符 “(” 應(yīng)該用空格隔開。如while (true) 注意:在方法名和左括符“(”之間不要使用空格，這樣有助于辨認代碼中的方法調(diào)用與關(guān)鍵字。 2）多個參數(shù)用逗號隔開，每個逗號后都應(yīng)加一個空格。 3） 除了 .之外，所有的二元操作符都應(yīng)用空格與它們的操作數(shù)隔開。一元操作符、+及-與操作數(shù)間不需要空格。如： a += c + d; a = (a + b) / (c * d); 4）語句中的表達式之間用空格隔開。如 for (expr1; expr2; expr3) 6、花括號 - 1）左花括號 “” 放于關(guān)鍵字或方法名的下一行并與之對齊。如 if (

4、condition) 2）左花括號 “” 要與相應(yīng)的右花括號 “”對齊。 3）通常情況左花括號 “”單獨成行，不與任何語句并列一行。 4） if、while、do語句后一定要使用，即使只有一條語句。如 if (somevalue = 1) somevalue = 2; 6、花括號 - 5）右花括號 “” 后建議加一個注釋以便于方便的找到與之相應(yīng)的 。如 while (1) if (valid) else / if / while1、注釋概述1）在每個例程的開始，提供標準的注釋樣本以指示例程的用途、假設(shè)和限制很有幫助。注釋樣本應(yīng)該是解釋它為什么存在和可以做什么的簡短介紹。2） 避免在代碼行的末尾

5、添加注釋；行尾注釋使代碼更難閱讀。不過在批注變量聲明時，行尾注釋是合適的。3）避免在塊注釋的周圍加上印刷框。這樣看起來可能很漂亮，但是難于維護。4）在部署發(fā)布之前，移除所有臨時或無關(guān)的注釋，以避免在日后的維護工作中產(chǎn)生混亂。1、注釋概述5）在編寫注釋時使用完整的句子。注釋應(yīng)該闡明代碼，而不應(yīng)該增加多義性。6）在編寫代碼時就注釋，因為以后很可能沒有時間這樣做。7）為了防止問題反復(fù)出現(xiàn)，對錯誤修復(fù)和解決方法代碼總是使用注釋，尤其是在團隊環(huán)境中。8）在所有的代碼修改處加上修改標識的注釋。9）用空白將注釋同注釋分隔符分開。在沒有顏色提示的情況下查看注釋時，這樣做會使注釋很明顯且容易被找到。2、 文件注

6、釋在每個文件頭必須包含以下注釋說明/ / Copyright (c) HP. All rights reserved./ / / yyyy-mm-dd / 文件功能描述/ / 修改人：/ 修改時間：yyyy-mm-dd/ 修改描述：/ 版本：1.0/3、文檔型注釋 1） 類、接口注釋 / / 類功能的說明 / / / / 創(chuàng)建人：Zhangsan / 創(chuàng)建日期：yyyy-mm-dd / 修改人：Lisi / 修改日期：yyyy-mm-dd / 修改備注：無 / 版本：1.0 / 3、文檔型注釋 2 ）方法、事件注釋 / / 根據(jù)員工編號獲得員工信息 / / 員工編號 / 系統(tǒng)異常 / 員工姓名

7、 / / 創(chuàng)建人：Zhangsan / 創(chuàng)建日期：yyyy-mm-dd / 修改人：Lisi / 修改日期：yyyy-mm-dd / 修改備注：無 / 版本：1.1 / 3、文檔型注釋 2 ）方法、事件注釋 / / 根據(jù)員工編號獲得員工信息 / / 員工編號 / 系統(tǒng)異常 / 員工姓名 / / 創(chuàng)建人：Zhangsan / 創(chuàng)建日期：yyyy-mm-dd / 修改人：Lisi / 修改日期：yyyy-mm-dd / 修改備注：無 / 版本：1.1 / 1 、每行聲明數(shù)一行只作一個聲明,如 int level; /推薦 int size; /推薦 int x, y; /不推薦2、初始化 建議在變

8、量聲明時就對其做初始化。3、位置 變量建議置于塊的開始處，不要總是在第一次使用它們的地方做聲明。 1 、命名概述名稱應(yīng)該說明“什么”而不是“如何”。提供人們可以理解的名稱。1）避免容易被主觀解釋的難懂的名稱，如方面名AnalyzeThis()，或者屬性名xx8。這樣的名稱會導(dǎo)致多義性。2）在變量名中使用互補對，如 min/max、begin/end和 open/close。3）布爾變量名應(yīng)該包含Is，這意味著Yes/No或True/False值，如fileIsFound。4）即使對于可能僅出現(xiàn)在幾個代碼行中的生存期很短的變量，仍然使用有意義的名稱。僅對于短循環(huán)索引使用單字母變量名，如i或j。1

9、 、命名概述5）用名詞或名詞詞組來給類型命名，在少數(shù)情況下也可以用形容詞詞組來給類型命名6）用動詞或動詞詞組來命名方法7）用名詞、名詞詞組或形容詞來命名屬性8）要用動詞或動詞短語來命名事件9）要用名詞或名詞短語來命名字段2、Pascal大小寫將標識符的首字母和后面連接的每個單詞的首字母都大寫。可以對三字符或更多字符的標識符使用Pascal大小寫。例如： BackColor3 、控件命名1） 命名方法控件名簡寫+英文描述，英文描述首字母大寫2） 主要控件名簡寫對照表控件名簡寫控件名簡寫LabellblTextBoxtxtButtonbtnLinkButtonlnkbtnImageButtonim

10、gbtnDropDownListddlListBoxlstDataGriddgDataListdlCheckBoxchkCheckBoxListchklsRadioButtonrdoRadioButtonListrdoltImageimgPanelpnlCalendercldAdRotatorarTabletblRequiredFieldValidatorrfvCompareValidatorcvRangeValidatorrvRegularExpressionValidatorrevValidatorSummaryvsCrystalReportViewerrptvew3 、控件命名1） 命名方法控件名簡寫+英文描述，英文描述首字母大寫2） 主要控件名簡寫對照表控件名簡寫控件名簡寫LabellblTextBoxtxtButtonbtnLinkButtonlnkbtnImageButtonimgbtnDropDownListddlListBoxlstDataGriddgDataListdlCheckBoxchkCheckBoxListchklsRadioButtonrdoRadioButtonListrdoltImageimgPa