軟件有限公司呼叫中心項(xiàng)目軟件開(kāi)發(fā)代碼規(guī)范性標(biāo)準(zhǔn).docx

1、軟件有限公司呼叫中心項(xiàng)目軟件開(kāi)發(fā)代碼規(guī)范性標(biāo)準(zhǔn)1概述1.1目的 制定規(guī)范，約束開(kāi)發(fā)人員在開(kāi)發(fā)過(guò)程中隨意性、不 規(guī)范性，減少開(kāi)發(fā)后期帶來(lái)的不必要的成本浪費(fèi)。1.2要求 開(kāi)發(fā)人員開(kāi)發(fā)之前,必須通讀開(kāi)發(fā)規(guī)范中的內(nèi)容（理 解規(guī)范中的要求）。 在開(kāi)發(fā)過(guò)程中，必須嚴(yán)格執(zhí)行規(guī)范中制定的規(guī)范內(nèi) 容，如果檢查過(guò)程中發(fā)現(xiàn)沒(méi)有按規(guī)范執(zhí)行的，按呼叫中心 項(xiàng)目軟件開(kāi)發(fā)代碼規(guī)范性檢查辦法執(zhí)行。2規(guī)范細(xì)則詳述2.1注釋所有的注釋文字一律使用簡(jiǎn)體中文。2.1.1類注釋在import語(yǔ)句和class聲明語(yǔ)句之間必須加類的注釋,格式如下：要有功能說(shuō)明、創(chuàng)建人、創(chuàng)建日期、修改人（如 果修改了部分代碼）、修改日期、修改說(shuō)明、版本號(hào)。

2、2.1.2方法注釋1）在方法前必須添加注釋。2）對(duì)于設(shè)置（Set方法）與獲?。℅et方法）成員的方法， 在成員變量已有說(shuō)明的情況下，可以不加注釋。3）對(duì)于類似stuts的ACTION方法，其輸入輸出參數(shù)固 定、格式統(tǒng)一的，參數(shù)說(shuō)明可以省略。2.1.3屬性注釋1）注釋格式：注釋內(nèi)容。寫(xiě)明該屬性的含義。2.1.4代碼內(nèi)注釋1）主要變量定義、引用及復(fù)雜的算法需注釋。2）代碼段落注釋，說(shuō)明以下代碼段在該方法中具體實(shí) 現(xiàn)的功能；3）注釋格式：/注釋內(nèi)容或以“/*”開(kāi)始，*/”結(jié)尾 注釋。2.1.5修改注釋當(dāng)創(chuàng)建人與修改人不是同一個(gè)的情況下，需加修改注釋O1）在增加的代碼前添加注釋，內(nèi)容包括增加部分功能

3、說(shuō)明、增加人、增加日期、增加部分開(kāi)始聲明。2）結(jié)束部分添加注釋，注釋內(nèi)容包括增加部分功能說(shuō) 明、增加人、增加日期、增加部分結(jié)束聲明。3）以上包括增加、修改和刪除的注釋。2.2命名2. 2.1包命名1）包的名字應(yīng)該能夠說(shuō)明包的用途，通常應(yīng)是名詞或 名詞短語(yǔ)。包的名字應(yīng)該全部由小寫(xiě)字母構(gòu)成.；2）如果包的用途必須由兩個(gè)或多個(gè)單詞才能描述清楚, 可以直接將這些單詞連接作為包名.”；3）如果連接后的包名太長(zhǎng)，可以使用單詞的縮寫(xiě)（縮 寫(xiě)必須不會(huì)引起歧義）或取每個(gè)單詞的首字母。2. 2.2類命名1）首字母大寫(xiě)；2）類的名字應(yīng)該能夠說(shuō)明類的用途，通常應(yīng)是名詞或 名詞短語(yǔ)。類的名字由若干單詞連接而成，每個(gè)單詞

4、的首字 母應(yīng)大寫(xiě)，其他字母小寫(xiě)；3）如果某個(gè)詞是一個(gè)縮寫(xiě)形式，則這個(gè)詞應(yīng)全部大寫(xiě)2. 2.3方法命名1）所有的方法（構(gòu)造函數(shù)除外）名都應(yīng)能說(shuō)明方法的 用途，通常取動(dòng)詞或動(dòng)詞短語(yǔ)，也可能是名詞或名詞短語(yǔ)。 方法名由若干單詞連接而成，第一個(gè)單詞應(yīng)全部小寫(xiě)，其余 單詞的首字母大寫(xiě)。2）對(duì)于以名詞或名詞短語(yǔ)命名的方法，建議改成動(dòng)詞 或動(dòng)詞短語(yǔ)形式。2. 2.4變量命名1）通常由13個(gè)英文單詞/簡(jiǎn)寫(xiě)組成，盡量不能超過(guò) 4個(gè)單詞；2）通常組成形式是：形容詞+名詞，名詞+名詞，動(dòng)詞+ 名詞；如：nUserNum, AddUser. jsp3）每個(gè)變量首字母必須小寫(xiě),每個(gè)單詞首字母大寫(xiě)（數(shù) 據(jù)庫(kù)除外）；4）可

5、以添加數(shù)字或下劃線的組合；5）避免使用類似的名字如變量名persistentObject 與 persistentObjects 不能同用；6）絕對(duì)禁止包含漢字、拼音、無(wú)含義字母、空格和特 殊字符；2. 2.5常量命名1) 變量的名字應(yīng)該都大寫(xiě)，并且指出完整含義。2. 2.6 JSP 命名4) Jsp的文件的開(kāi)頭都以小寫(xiě)開(kāi)頭，其他單詞第一字 母要大寫(xiě)，其余小寫(xiě)。5) 同一個(gè)業(yè)務(wù)建立一個(gè)意義相同單詞的目錄，且相同 的jsp都在相同的目錄下。2. 2.7 SSH 命名2. 2. 7. 1 Package的命名及應(yīng)用包的最上層規(guī)定為com. order, cc1) 在每次增加一個(gè)業(yè)務(wù)功能時(shí)，就要增加

6、一個(gè)新包， 新包下的結(jié)構(gòu)包括：action、form、entity、dao idaoSVCo2) action： jsp提交時(shí)對(duì)應(yīng)的方法入口。3) form： jsp與后臺(tái)數(shù)據(jù)的緩沖。4) entity：相關(guān)數(shù)據(jù)對(duì)象的實(shí)體文件。5) dao：所有的數(shù)據(jù)庫(kù)操作都要在此類中完成，禁止數(shù) 據(jù)庫(kù)sql在其他類中出現(xiàn)。6) idao： dao 的接口類。7) svc：業(yè)務(wù)邏輯在此類中實(shí)現(xiàn)，與dao掛鉤。注此包在命名可以根據(jù)具體的功能來(lái)靈活命名，一般 業(yè)務(wù)可以參照此包的結(jié)構(gòu)來(lái)實(shí)現(xiàn)2. 2. 7. 2 Class的命名及應(yīng)用1) Class的名字必須由大寫(xiě)字母開(kāi)頭并且每個(gè)獨(dú)立的 單詞第一個(gè)字母也必須以大寫(xiě)開(kāi)

7、頭，其他字母都小寫(xiě)的單詞 組成。2) Action類名形式：描述性名稱+Action. java3) Form類名形式：描述性名稱+Form. java4) Entity類名形式：描述性名稱+Entity. java5) Dao類類名形式：描述性名稱+DAO. java6) IDao類類名形式：1+描述性名稱+DAO. java7) svc類類名形式：描述性名稱+Serivce. java注.此類的命名是對(duì)上面包命名的一個(gè)規(guī)定，如包不屬 于上述結(jié)構(gòu)，class完全可以不依照上面的命名在struts-config. xml命名path時(shí)，不要帶路徑，防 止路徑混亂。正確的命名如下：path=/menuAction”2.3格式2. 3.1縮進(jìn)規(guī)范1）類中的成分，使用縮進(jìn)；2）方法體或語(yǔ)句塊中的成分，使用縮進(jìn)；3）換行時(shí)的非起始行，使用縮進(jìn)；4）縮減量一般為在上一級(jí)成分的基礎(chǔ)上再縮進(jìn)四個(gè)空 格。2. 3.2空行規(guī)范1）包語(yǔ)句與import語(yǔ)句間空兩行；2）Import語(yǔ)句與class定義之間空兩行；3）方法與方法之間以空行分隔；4）函數(shù)內(nèi)部數(shù)據(jù)與代碼之間應(yīng)空至少一行，代碼中適 當(dāng)處應(yīng)以空行空開(kāi)，建議在代碼中出現(xiàn)變量聲明時(shí)，在其前 空一行；5）在方法內(nèi)部代碼的邏輯段落小節(jié)之間，