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

軟件有限公司呼叫中心項目軟件開發(fā)代碼規(guī)范性標(biāo)準(zhǔn)概述目的制定規(guī)范，約束開發(fā)人員在開發(fā)過程中隨意性、不規(guī)范性，減少開發(fā)后期帶來的不必要的成本浪費。要求開發(fā)人員開發(fā)之前，必須通讀開發(fā)規(guī)范中的內(nèi)容（理解規(guī)范中的要求）。在開發(fā)過程中，必須嚴(yán)格執(zhí)行規(guī)范中制定的規(guī)范內(nèi)容，如果檢查過程中發(fā)現(xiàn)沒有按規(guī)范執(zhí)行的，按《呼叫中心項目軟件開發(fā)代碼規(guī)范性檢查辦法》執(zhí)行。規(guī)范細(xì)則詳述注釋所有的注釋文字一律使用簡體中文。類注釋在import語句和class聲明語句之間必須加類的注釋，格式如下：要有功能說明、創(chuàng)建人、創(chuàng)建日期、修改人（如果修改了部分代碼）、修改日期、修改說明、版本號。方法注釋在方法前必須添加注釋。對于設(shè)置(Set方法)與獲取(Get方法)成員的方法，在成員變量已有說明的情況下，可以不加注釋。對于類似stuts的ACTION方法，其輸入輸出參數(shù)固定、格式統(tǒng)一的，參數(shù)說明可以省略。屬性注釋注釋格式：//注釋內(nèi)容。寫明該屬性的含義。代碼內(nèi)注釋主要變量定義、引用及復(fù)雜的算法需注釋。代碼段落注釋，說明以下代碼段在該方法中具體實現(xiàn)的功能；注釋格式：//注釋內(nèi)容或以“/*”開始，“*/”結(jié)尾注釋。修改注釋當(dāng)創(chuàng)建人與修改人不是同一個的情況下，需加修改注釋。在增加的代碼前添加注釋，內(nèi)容包括增加部分功能說明、增加人、增加日期、增加部分開始聲明。結(jié)束部分添加注釋，注釋內(nèi)容包括增加部分功能說明、增加人、增加日期、增加部分結(jié)束聲明。以上包括增加、修改和刪除的注釋。命名包命名包的名字應(yīng)該能夠說明包的用途，通常應(yīng)是名詞或名詞短語。包的名字應(yīng)該全部由小寫字母構(gòu)成.；如果包的用途必須由兩個或多個單詞才能描述清楚，可以直接將這些單詞連接作為包名.”；如果連接后的包名太長，可以使用單詞的縮寫（縮寫必須不會引起歧義）或取每個單詞的首字母。類命名首字母大寫；類的名字應(yīng)該能夠說明類的用途，通常應(yīng)是名詞或名詞短語。類的名字由若干單詞連接而成，每個單詞的首字母應(yīng)大寫，其他字母小寫；如果某個詞是一個縮寫形式，則這個詞應(yīng)全部大寫.。方法命名所有的方法（構(gòu)造函數(shù)除外）名都應(yīng)能說明方法的用途，通常取動詞或動詞短語，也可能是名詞或名詞短語。方法名由若干單詞連接而成，第一個單詞應(yīng)全部小寫，其余單詞的首字母大寫。對于以名詞或名詞短語命名的方法，建議改成動詞或動詞短語形式。變量命名通常由1—3個英文單詞/簡寫組成，盡量不能超過4個單詞；通常組成形式是：形容詞+名詞，名詞+名詞，動詞+名詞；如：nUserNum，AddUser.jsp每個變量首字母必須小寫，每個單詞首字母大寫（數(shù)據(jù)庫除外）；可以添加數(shù)字或下劃線的組合；避免使用類似的名字如變量名persistentObject與persistentObjects不能同用；絕對禁止包含漢字、拼音、無含義字母、空格和特殊字符；常量命名變量的名字應(yīng)該都大寫，并且指出完整含義。JSP命名Jsp的文件的開頭都以小寫開頭，其他單詞第一字母要大寫，其余小寫。同一個業(yè)務(wù)建立一個意義相同單詞的目錄，且相同的jsp都在相同的目錄下。SSH命名Package的命名及應(yīng)用包的最上層規(guī)定為com.order.cc在每次增加一個業(yè)務(wù)功能時，就要增加一個新包，新包下的結(jié)構(gòu)包括：action、form、entity、dao、idao、svc。action：jsp提交時對應(yīng)的方法入口。form：jsp與后臺數(shù)據(jù)的緩沖。entity：相關(guān)數(shù)據(jù)對象的實體文件。dao：所有的數(shù)據(jù)庫操作都要在此類中完成，禁止數(shù)據(jù)庫sql在其他類中出現(xiàn)。idao：dao的接口類。svc：業(yè)務(wù)邏輯在此類中實現(xiàn)，與dao掛鉤。注：此包在命名可以根據(jù)具體的功能來靈活命名，一般業(yè)務(wù)可以參照此包的結(jié)構(gòu)來實現(xiàn)Class的命名及應(yīng)用Class的名字必須由大寫字母開頭并且每個獨立的單詞第一個字母也必須以大寫開頭，其他字母都小寫的單詞組成。Action類名形式：描述性名稱+Action.javaForm類名形式：描述性名稱+Form.javaEntity類名形式：描述性名稱+Entity.javaDao類類名形式：描述性名稱+DAO.javaIDao類類名形式：I+描述性名稱+DAO.javasvc類類名形式：描述性名稱+Serivce.java注：此類的命名是對上面包命名的一個規(guī)定，如包不屬于上述結(jié)構(gòu)，class完全可以不依照上面的命名在struts-config.xml命名path時，不要帶路徑，防止路徑混亂。正確的命名如下：path="/menuAction"格式縮進規(guī)范類中的成分，使用縮進；方法體或語句塊中的成分，使用縮進；換行時的非起始行，使用縮進；縮減量一般為在上一級成分的基礎(chǔ)上再縮進四個空格?？招幸?guī)范包語句與import語句間空兩行；Import語句與class定義之間空兩行；方法與方法之間以空行分隔；函數(shù)內(nèi)部數(shù)據(jù)與代碼之間應(yīng)空至少一行，代碼中適當(dāng)處應(yīng)以空行空開，建議在代碼中出現(xiàn)變量聲明時，在其前空一行；在