團(tuán)隊(duì)開發(fā)項(xiàng)目開發(fā)規(guī)范

1、團(tuán)隊(duì)開發(fā)項(xiàng)目開發(fā)規(guī)范概述程序員一般需要團(tuán)隊(duì)合作，可能為了一個(gè)大型項(xiàng)目程序會(huì)有十人以上或者百人以上甚至千人以上的團(tuán)隊(duì)公司在一起工作。編碼規(guī)范使程序規(guī)范化，易懂化，才能更好的進(jìn)行合作。 編碼規(guī)范第一、使代碼更加易于維護(hù)，程序并不是一次性的產(chǎn)品，它需要擴(kuò)展、修改以及維護(hù)的。但是進(jìn)行這些操作的人并不一定就是同一個(gè)人，所以規(guī)范編碼是非常重要的。 編碼規(guī)范第二、可以提高代碼質(zhì)量，編程都不是一次性完成的，需要不斷的測(cè)試與調(diào)試，以各種狀態(tài)來修改代碼，而將代碼規(guī)范化，就能對(duì)程序本身有更加清晰的結(jié)構(gòu)思路，從而減少調(diào)試而成為快捷高效的代碼。 編碼規(guī)范第三、團(tuán)隊(duì)化。 一開始就要養(yǎng)成良好的編碼習(xí)慣，這樣將為團(tuán)隊(duì)帶來事半

2、功倍的效果。術(shù)語(yǔ)定義1. Pascal 大小寫將標(biāo)識(shí)符的首字母和后面連接的每個(gè)單詞的首字母都大寫?？梢詫?duì)三字符或更多字符的標(biāo)識(shí)符使用Pascal 大小寫。例如： DateTime2. Camel 大小寫標(biāo)識(shí)符的首字母小寫，而每個(gè)后面連接的單詞的首字母都大寫。例如：dateTime代碼之美編碼是一件很有趣的事，如果發(fā)現(xiàn)代碼的是一種美的語(yǔ)言的時(shí)候，編寫代碼再也不是枯燥的代名詞。2.1 列寬代碼列寬控制在110字符左右。2.2 換行當(dāng)表達(dá)式超出或即將超出規(guī)定的列寬，遵循以下規(guī)則進(jìn)行換行a) 在逗號(hào)后換行；b) 在操作符前換行；c) 規(guī)則a優(yōu)先于規(guī)則b。 2.3 縮進(jìn) 縮進(jìn)應(yīng)該是每行一個(gè)Tab(4個(gè)空

3、格)，不要在代碼中使用Tab字符。2.4 空行空行是為了將邏輯上相關(guān)聯(lián)的代碼分塊，以便提高代碼的可閱讀性。在代碼中，不能包含多個(gè)空行。 在以下情況下使用一個(gè)空行：1、方法與方法、屬性與屬性之間。2、方法中變量聲明與語(yǔ)句之間。3、方法與方法之間。4、方法中不同的邏輯塊之間。5、方法中的返回語(yǔ)句與其他的語(yǔ)句之間。6、屬性與方法、屬性與字段、方法與字段之間。7、注釋與它注釋的語(yǔ)句間不空行，但與其他的語(yǔ)句間空一行。2.5 空格在以下情況中要使用到空格：1、 關(guān)鍵字和左括符 “(” 應(yīng)該用空格隔開。如while (true) 注意:在方法名和左括符 “(” 之間不要使用空格，這樣有助于辨認(rèn)代碼中的方法調(diào)

4、用與關(guān)鍵字。2、多個(gè)參數(shù)用逗號(hào)隔開，每個(gè)逗號(hào)后都應(yīng)加一個(gè)空格。3、除了 . 之外，所有的二元操作符都應(yīng)用空格與它們的操作數(shù)隔開。一元操作符、+及-與操作數(shù)間不需要空格。如/字符測(cè)試0opxXnNjgasqwMm1lIa += c + d; a = (a + b) / (c * d);while (d+ = s+)n+; Response.Write (“size is “ + size); 4、 語(yǔ)句中的表達(dá)式之間用空格隔開。如for (expr1; expr2; expr3)2.6 括號(hào) - ()1、 左括號(hào)“(” 不要緊靠關(guān)鍵字，中間用一個(gè)空格隔開。2、 左括號(hào)“(” 與方法名之間不要添加

5、任何空格。3、 沒有必要的話不要在返回語(yǔ)句中使用()。如if (condition)Array.Remove(1)return 1 2.7 花括號(hào) - 1、左花括號(hào) “” 放于關(guān)鍵字或方法名的下一行并與之對(duì)齊。如if (condition)public int Add(int x, int y)2、左花括號(hào) “” 要與相應(yīng)的右花括號(hào) “”對(duì)齊。3、通常情況下左花括號(hào) “”單獨(dú)成行，不與任何語(yǔ)句并列一行。4、 if、while、do語(yǔ)句后一定要使用，即使號(hào)中為空或只有一條語(yǔ)句。如if (somevalue = 1)somevalue = 2 5、右花括號(hào) “” 后建議加一個(gè)注釋以便于方便的找到與

6、之相應(yīng)的 。如while (condition)if (condition) else / if / while代碼注釋城3.1 注釋概述1、修改代碼時(shí)，總是使代碼周圍的注釋保持最新。2、在每個(gè)例程的開始，提供標(biāo)準(zhǔn)的注釋樣本以指示例程的用途、假設(shè)和限制很有幫助。注釋樣本應(yīng)該是解釋它為什么存在和可以做什么的簡(jiǎn)短介紹.3、避免在代碼行的末尾添加注釋；行尾注釋使代碼更難閱讀。不過在批注變量聲明時(shí)，行尾注釋是合適的；在這種情況下，將所有行尾注釋在公共制表位處對(duì)齊。 4 、避免雜亂的注釋，如一整行星號(hào)。而是應(yīng)該使用空白將注釋同代碼分開。 5 、避免在塊注釋的周圍加上印刷框。這樣看起來可能很漂亮，但是難于

7、維護(hù)。6 、在部署發(fā)布之前，移除所有臨時(shí)或無(wú)關(guān)的注釋，以避免在日后的維護(hù)工作中產(chǎn)生混亂。7 、如果需要用注釋來解釋復(fù)雜的代碼節(jié)，請(qǐng)檢查此代碼以確定是否應(yīng)該重寫它。盡一切可能不注釋難以理解的代碼，而應(yīng)該重寫它。盡管一般不應(yīng)該為了使代碼更簡(jiǎn)單以便于人們使用而犧牲性能，但必須保持性能和可維護(hù)性之間的平衡。8 、在編寫注釋時(shí)使用完整的句子。注釋應(yīng)該闡明代碼，而不應(yīng)該增加多義性。 9 、在編寫代碼時(shí)就注釋，因?yàn)橐院蠛芸赡軟]有時(shí)間這樣做。另外，如果有機(jī)會(huì)復(fù)查已編寫的代碼，在今天看來很明顯的東西六周以后或許就不明顯了。10 、避免多余的或不適當(dāng)?shù)淖⑨?，如幽默的不主要的備注?1、 使用注釋來解釋代碼的意圖。

8、它們不應(yīng)作為代碼的聯(lián)機(jī)翻譯。 12、 注釋代碼中不十分明顯的任何內(nèi)容。13 、為了防止問題反復(fù)出現(xiàn)，對(duì)錯(cuò)誤修復(fù)和解決方法代碼總是使用注釋，尤其是在團(tuán)隊(duì)環(huán)境中。14 、對(duì)由循環(huán)和邏輯分支組成的代碼使用注釋。這些是幫助源代碼讀者的主要方面。 15 、在整個(gè)應(yīng)用程序中，使用具有一致的標(biāo)點(diǎn)和結(jié)構(gòu)的統(tǒng)一樣式來構(gòu)造注釋。 16 、用空白將注釋同注釋分隔符分開。在沒有顏色提示的情況下查看注釋時(shí)，這樣做會(huì)使注釋很明顯且容易被找到。17 、在所有的代碼修改處加上修改標(biāo)識(shí)的注釋。18 、為了是層次清晰，在閉合的右花括號(hào)后注釋該閉合所對(duì)應(yīng)的起點(diǎn)。namespace Oursss.ManagerPaper.Web /

9、 namespace Oursss.ManagerPaper.Web3.2 文件注釋在每個(gè)文件頭必須包含以下注釋說明/ 名稱：XXX/ Copyright (c) DriveTOP. All rights reserved./ 作者：RennErann/ 創(chuàng)建日期：2011-03-21 / 功能描述：/-/ 修改人：×××/ 修改時(shí)間：yyyy-mm-dd/ 修改描述：×××/ 版本：2.0.110321注意：文件功能描述只需簡(jiǎn)述，具體詳情在類的注釋中描述。創(chuàng)建標(biāo)識(shí)和修改標(biāo)識(shí)由創(chuàng)建或修改人員的拼音或英文名。如：RennErann。一天

10、內(nèi)有多個(gè)修改的只需做一個(gè)在注釋說明中做一個(gè)修改標(biāo)識(shí)就夠了。在所有的代碼修改處加上修改標(biāo)識(shí)的注釋。3.3 文檔型注釋該類注釋采用.Net已定義好的Xml標(biāo)簽來標(biāo)記，在聲明接口、類、方法、屬性、字段都應(yīng)該使用該類注釋，以便代碼完成后直接生成代碼文檔，讓別人更好的了解代碼的實(shí)現(xiàn)和接口。如1、 類、接口注釋/ <summary>/ 類功能的說明/ </summary>/ <see cref=""></see>/ <remarks>/ 創(chuàng)建人：RennErann/ 創(chuàng)建日期：yyyy-mm-dd/ 修改人：iflash50/

11、 修改日期：yyyy-mm-dd/ 修改備注：無(wú)/ 版本：1.0/ </remarks>public class CountersModuleInitializer : ModuleInitializer注意：<see cref=""></see>標(biāo)簽根據(jù)具體情況選擇有無(wú)2、 方法、事件注釋/ <summary>/ 根據(jù)應(yīng)聘人員ID獲得應(yīng)聘人員信息/ </summary>/ <param name="applyId">應(yīng)聘人員ID</param>/ <excepti

12、on cref="System.Exception">系統(tǒng)異常</exception>/ <returns>應(yīng)聘人員姓名</returns>/ <remarks>/ 創(chuàng)建人：RennErann/ 創(chuàng)建日期：yyyy-mm-dd/ 修改人：iflash50/ 修改日期：yyyy-mm-dd/ 修改備注：無(wú)/ 版本：1.1/ </remarks>public string GeApplyNameById(int applyId)tryreturn "李山"catch (System.Excep

13、tion)throw;注意：該方法注釋中的<param></param>、<exception cref=" "></exception>、<returns></returns>等標(biāo)簽根據(jù)具體情況選擇有無(wú)，方法初始版本為1.0，每次改動(dòng)增加0.1。3、 屬性、常量注釋/ <summary>/ session id/ </summary>public const string SESSION_ID = ""3.4 單行注釋該類注釋用于1 方法內(nèi)的代碼注釋。如變量

14、的聲明、代碼或代碼段的解釋。注釋示例： / 注釋語(yǔ)句private int number; 2 方法內(nèi)變量的聲明或花括號(hào)后的注釋, 注釋示例： if (true) / always truereturn 1; else / always false3.5 JavaScript注釋a) 注釋符號(hào)/不允許使用/*/作注釋符。b) 函數(shù)注釋每個(gè)函數(shù)都應(yīng)該描述該函數(shù)的名稱、功能、作用范圍、入口參數(shù)的類型和傳值方式及參數(shù)含義、返回值類型及返回值的含義。格式如下：/Function: 函數(shù)名/Purpose: 用途/Scope: 作用范圍/Args: 入口參數(shù)(列表) 類型傳值方式含義/Returns:

15、返回值類型 (可確定值列表) 含義/c) 非函數(shù)注釋注明該模塊的作用。格式如下：/功能：/d) 程序行間注釋在程序行的每一個(gè)處理單元前作注釋。格式如下：/注釋e) 注釋舉例/Function: F_FindObject/Purpose: 按照空間名在可視化主對(duì)象中查找住對(duì)象內(nèi)的可視化控件/Scope: Public/Args: is_name String value：要查找的空間名/ ipbo_object Object value: 可視化主對(duì)象/Returns: Boolean True 表示找到該控件/ False 表示沒有找到該控件/function F_FindObject(is_

16、name, ipbo_object) /獲得顯示學(xué)生信息的GreeView控件var gv_student = document.getElementById("GVStudent");*/返回truereturn true;3.6 3.5注釋標(biāo)簽標(biāo)簽用法作用<c>c>text</c>text 希望將其指示為代碼的文本。為您提供了一種將說明中的文本標(biāo)記為代碼的方法。使用 <code> 將多行指示為代碼<para><para>content</para>content段落文本。用于諸如 <re

17、marks> 或 <returns> 等標(biāo)記內(nèi)，使您得以將結(jié)構(gòu)添加到文本中。<param><param name='name'>description</param>name 為方法參數(shù)名。將此名稱用單引號(hào)括起來 (' ')。應(yīng)當(dāng)用于方法聲明的注釋中，以描述方法的一個(gè)參數(shù)。<paramref> <paramref name="name"/>name 要引用的參數(shù)名。將此名稱用雙引號(hào)括起來 (" ")。<paramref> 標(biāo)記為您提供

18、了一種指示詞為參數(shù)的方法。可以處理 XML 文件，從而用某種獨(dú)特的方法格式化該參數(shù)。<see><see cref="member"/>cref = "member" 對(duì)可以通過當(dāng)前編譯環(huán)境進(jìn)行調(diào)用的成員或字段的引用。編譯器檢查到給定代碼元素存在后，將 member 傳遞給輸出 XML 中的元素名。必須將 member 括在雙引號(hào) (" ") 中。使您得以從文本內(nèi)指定鏈接。使用 <seealso> 指示希望在“請(qǐng)參閱”一節(jié)中出現(xiàn)的文本。<seealso><seealso cref=&

19、quot;member"/>cref = "member" 對(duì)可以通過當(dāng)前編譯環(huán)境進(jìn)行調(diào)用的成員或字段的引用。編譯器檢查到給定代碼元素存在后，將 member 傳遞給輸出 XML 中的元素名。必須將 member 括在雙引號(hào) (" ") 中使您得以指定希望在“請(qǐng)參閱”一節(jié)中出現(xiàn)的文本。使用 <see> 從文本<example><example>description</example>description 代碼示例的說明。使用 <example> 標(biāo)記可以指定使用方法或其他庫(kù)成

20、員的示例。一般情況下，這將涉及到 <code> 標(biāo)記的使用。<code><code>content</code>content 為希望將其標(biāo)記為代碼的文本。 記為您提供了一種將多行指示為代碼的方法。使用 <c> 指示應(yīng)將說明中的文本標(biāo)記為代碼<summary><summary>description</summary>此處description 為對(duì)象的摘要。應(yīng)當(dāng)用于描述類型成員。使用 <remarks> 以提供有關(guān)類型本身的信息。<exception><excepti

21、on cref="member">description</exception>cref = "member" 對(duì)可從當(dāng)前編譯環(huán)境中獲取的異常的引用。編譯器檢查到給定異常存在后，將 member 轉(zhuǎn)換為輸出 XML 中的規(guī)范化元素名。必須將 member 括在雙引號(hào) (" ") 中。description 說明。<exception> 標(biāo)記使您可以指定類能夠引發(fā)的異常。<include><include file='filename' path='tagpathn

22、ame="id"' />filename 包含文檔的文件名。該文件名可用路徑加以限定。將 filename 括在單引號(hào)中 (' ')。 Tagpath：filename 中指向標(biāo)記名的標(biāo)記路徑。將此路徑括在單引號(hào)中 (' ')。 name 注釋前邊的標(biāo)記中的名稱說明符；名稱具有一個(gè) id。 id 位于注釋之前的標(biāo)記的 id。將此 id 括在雙引號(hào)中 (" ")。<include> 標(biāo)記使您得以引用描述源代碼中類型和成員的另一文件中的注釋。這是除了將文檔注釋直接置于源代碼文件中之外的另一種可選方法。

23、<include> 標(biāo)記使用 XML XPath 語(yǔ)法。有關(guān)自定義 <include> 使用的方法，請(qǐng)參閱 XPath 文檔。<list> <list type="bullet" | "number" | "table"><listheader><term>term</term><description>description</description></listheader><item><ter

24、m>term</term><description>description</description></item></list>term 定義的項(xiàng)，該項(xiàng)將在 text 中定義。description 目符號(hào)列表或編號(hào)列表中的項(xiàng)或者 term 的定義。<listheader> 塊用于定義表或定義列表中的標(biāo)題行。定義表時(shí)，只需為標(biāo)題中的項(xiàng)提供一個(gè)項(xiàng)。列表中的每一項(xiàng)用 <item> 塊指定。創(chuàng)建定義列表時(shí)，既需要指定 term 也需要指定 text。但是，對(duì)于表、項(xiàng)目符號(hào)列表或編號(hào)列表，只需為 text 提供一個(gè)項(xiàng)。列表或表所擁有的 <item> 塊數(shù)可以根據(jù)需要而定。<permission&g