編碼規(guī)范及要求

          Posted on 2007-03-21 20:55 Jaunt 閱讀(599) 評(píng)論(0)  編輯  收藏 所屬分類: 軟件工藝

          ?

          1. 類文件的放置要求:
          分包的原則是首先按層劃分,其次是按模塊劃分:
          ① com.yinhe.common????? 放置本應(yīng)用的公共類
          (例如:GlobalNames.java、DBConnection.java等);
          ② com.yinhe.util????????? 放置可以被其它web應(yīng)用重復(fù)利用的公共類文件
          (例如:編碼過(guò)濾器EncodeFilter.java、
          安全過(guò)濾器SavetyFilter.java、
          字符過(guò)濾器 WordFilter.java、
          html語(yǔ)言過(guò)濾器HtmlToString.java、
          GBK轉(zhuǎn)碼類 GBKToString.java等);
          ③ com.yinhe.login.web???? 放置在視圖層(jsp)中用到的JavaBean值對(duì)象
          (例如:UserInfVO.java);
          ④ com.yinhe.login.control? ? 放置控制類和ActionForm
          (例如:Struts中的 LoginAction.java、UserForm.java);
          ⑤ com.yinhe.login.dto????? 放置在業(yè)務(wù)邏輯層中用到的JavaBean數(shù)據(jù)傳輸對(duì)象
          (例如:UserInfDTO.java);
          ⑥ com.yinhe.login.modle??? 放置業(yè)務(wù)操作實(shí)體類(例如:UserDAO.java);
          ⑦ com.yinhe.login.pojo???? 放置JavaBean持久對(duì)象(例如:User.java);
          ⑧ conf?????????????????? 放置工程配制文件
          (例如:ApplicationResources.properties、global.properties)
          ?? conf.spring???????????? 放置Spring配制文件(例如:applicationContext.xml等)
          ?? conf.hibernate?????????? 放置Hibernate配制文件(例如:hibernate.cfg.xml等)
          ?
          ⑨ WEB-INF\conf? ???????? 放置struts屬性配置文件

          2. jsp文件的放置要求:
          ① 所有受保護(hù)的(過(guò)直接路徑不允許訪問(wèn)的頁(yè)面)放在admins下面,
          admins下面的left.jsp放置菜單,top.jsp放置logo,main.jsp為主工作區(qū),
          wellcome.jsp為默認(rèn)的首頁(yè)(登錄成功之后的顯示頁(yè)面);
          ② 默認(rèn)的訪問(wèn)首頁(yè)命名為: index.jsp;

          3. 樣式文件的放置要求:
          ① 按照模塊劃分放置在/css/模塊名;公用的樣式放在common.css下面;

          4. 圖片文件的放置要求(非上傳文件):
          ① 按照模塊劃分放置在/images/模塊名;

          5. 腳本文件的放置要求:
          ① 按照模塊劃分放置在/js/模塊名;公用的樣式放在common.js下面;

          6. 上傳文件的放置要求:
          ① 圖片文件放在upload/pic/模塊名/文件;
          ② 非圖片文件放在upload/other/文件;

          7. 命名要求:
          ① 所有jsp文件一律小寫;
          ② 所有靜態(tài)文件的后綴名一律以.htm結(jié)尾;

          ③ 所有類文件都必須嚴(yán)格區(qū)分大小寫,
          接口必須以I開頭,實(shí)現(xiàn)類以Imp結(jié)尾 (例如IUser.java , UserImp.java),
          如果是ActionForm必須以Form結(jié)尾(UserForm.java);
          控制類必須以Action結(jié)尾(UserAction.java);
          視圖類必須以VO結(jié)尾(UserVO.java);
          所有操作數(shù)據(jù)庫(kù)的業(yè)務(wù)類必須以DAO結(jié)尾(UserDao.java);
          所有數(shù)據(jù)傳輸對(duì)象必須以DTO結(jié)尾(UserDTO);

          ④ 所有的包一律小寫,分包的原則是首先按層分其次是按模塊劃分;
          ?包名的第一及多為com或者org;
          ⑤ 所有java文件中的變量按照java的要求命名,常量一律全大寫;
          ⑥ 數(shù)據(jù)庫(kù)命名:
          ?表名和java的實(shí)體類名對(duì)應(yīng)而且全部大寫(例如 USER 表對(duì)應(yīng) UserDAO.java);
          ?
          ⑦ 存儲(chǔ)過(guò)程的命名:
          傳入?yún)?shù)以p_開頭(例如p_user),局部變量以v_開頭(例如 v_intCount),
          存儲(chǔ)過(guò)程的名稱以p_開頭(例如 p_add),
          觸發(fā)器以t_開頭(例如 t_update),視圖以v_開頭(v_list_user),
          所有參數(shù)的命名按照前面的原則:
          主鍵以PK_開頭,外鍵以FK_開頭,唯一鍵用UN_開頭,
          檢查約束用CHK_開頭,默認(rèn)值用DEF_開頭,
          每個(gè)表都必須有一個(gè)物理ID(自動(dòng)產(chǎn)生),其命名為ID;
          同時(shí)還應(yīng)該有一個(gè)邏輯ID,其命名為"表名_"+ID(例如 USER_ID);

          ?⑧ 所有的java源文件和數(shù)據(jù)庫(kù)的數(shù)據(jù)對(duì)象必須有注釋,必須嚴(yán)格按照相應(yīng)的規(guī)則注釋,不要為了寫注釋而寫注釋,java的注釋必須能自動(dòng)形成JavaDOC文檔;

          8. 關(guān)于提交代碼的規(guī)定:
          ?① 每天上班前必須和CVS同步,每天下班前必須提交自己的代碼和文檔(代碼必須在本地被編譯通過(guò));
          ?② 當(dāng)本地文件和CVS產(chǎn)生沖突的時(shí)候不要強(qiáng)行覆蓋,必須找出沖突的原因,消除沖突后再提交,千萬(wàn)不要把別人的代碼給盲目的覆蓋了;
          ?③ 如果發(fā)現(xiàn)jsp文件發(fā)生了改變,如果是二進(jìn)制的比較方式,可能因?yàn)樵黾恿藫Q行和回車或者空格而產(chǎn)生沖突,這時(shí)可不考慮沖突的問(wèn)題;

          9. 其它事宜:
          ① 加強(qiáng)溝通,形成高效+創(chuàng)新+強(qiáng)戰(zhàn)斗力的團(tuán)隊(duì)!
          ② 服從分配,按時(shí)保質(zhì)保量完成任務(wù)~!


          ?


          只有注冊(cè)用戶登錄后才能發(fā)表評(píng)論。


          網(wǎng)站導(dǎo)航:
           
          主站蜘蛛池模板: 武威市| 泾源县| 油尖旺区| 禄丰县| 泸西县| 饶阳县| 建平县| 永泰县| 盐池县| 广宁县| 东安县| 绩溪县| 金堂县| 宝应县| 巴彦县| 应用必备| 杭锦后旗| 玛纳斯县| 博乐市| 驻马店市| 旬邑县| 阜阳市| 舟曲县| 万源市| 林西县| 岳池县| 简阳市| 绵竹市| 札达县| 东城区| 肇州县| 兖州市| 古丈县| 马龙县| 兴海县| 电白县| 利津县| 汕尾市| 益阳市| 淮滨县| 敦化市|