資源描述：
《項目命名規(guī)范》由會員上傳分享，免費在線閱讀，更多相關內容在應用文檔-天天文庫。
1、《網(wǎng)站后臺管理系統(tǒng)命名規(guī)范》注：本文中標注【規(guī)則-*】的條款必須嚴格執(zhí)行，標注【建議-*】的條款為提倡采用。1．JSP頁面命名規(guī)則?【規(guī)則-1】大小寫：所有文件的首字母小寫；【規(guī)則-2】命名：根據(jù)頁面的功能，一般為業(yè)務名稱+功能；如：loginInof_edit.jsp，其中操作對象的首字母小寫；?【規(guī)則-2】常用的操作動作：新增：_new編輯：_edit查看：_view列表：_list詳細：_info審批：_audit確認：_confirm查詢：_query注：各頁面命名總體如此，要求意思表達完整。2.包的命名（PackageNames）【規(guī)則-1】包名應該都用小寫字母組成
2、。例如：dao/entity包的命名：net.zzvc.szmt.aug.dao實現(xiàn)類包含子包impl.entity實體類.common公共類，如時間函數(shù).biz業(yè)務類包含子包impl.web包含子包Action，F(xiàn)orm.config配置文件3.類和接口的命名（ClassNames）【規(guī)則-1】類名采用第一個字母大寫其他字母小寫的形式。【規(guī)則-2】由多個單詞組成的類名采用單詞的第一個字母大寫其他小寫的形式。例如：ClassUserDaoAction類均以類說明加*-Action形式；例如：AdminActionForm類均以類說明加*-Form形式；例如：AdminForm
3、Biz類均以類說明加*-Biz形式；例如：AdminBizDao類均以類說明加*-Dao形式；例如：AdminDao【規(guī)則-3】接口的聲明均以I開頭以相應類聲明規(guī)范形式結尾，如：IAdminDao、IAdminBiz。4.變量的命名（ConstantNames）【規(guī)則-1】變量名應盡量使用對應英文或中文縮寫，不能隨便起名，影響編碼人員編程?！疽?guī)則-2】構成名稱的各單詞均用大寫，并且各單詞之間用“_”分割。例：MAX_SIZE程序中應該使用常量代替“25”，“100”等實際的數(shù)字，如：//推薦if(times==MAX_TIMES){}//避免if(times==25){}5.
4、方法的命名（MethodsNames）【規(guī)則-1】方法名以小寫字母開頭，以后每個單詞的第一個字母大寫，即駝峰命名法。【規(guī)則-2】因為方法是在它所在的類的上下文中被調用的，所以沒有必要在方法名中重復類的名字。例如類Customer中有一個方法可以提取顧客的名字，我們應該把這個方法命名為getName，而不是getCustomerName。當這個類的用戶要調用此方法時，他們只需寫customer.getName()，而不用寫成重復的customer.getCustomerName()?！疽?guī)則-3】當用一個方法調用同一個類或子類里的另一個方法時，需明確地使用“this.method
5、Name()”來強調你正在調用自己類里的方法?！疽?guī)則-4】命名：根據(jù)方法的功能命名。get*;獲取數(shù)據(jù)；比如：getAllUers();find*;檢索數(shù)據(jù)；比如：findUsersByID();load*;載入數(shù)據(jù)；比如：loadUserByID();insert*;添加數(shù)據(jù)；比如：insertUser();delete*;刪除數(shù)據(jù)，比如：deleteUser();update*;修改數(shù)據(jù)；比如：updateUser();select*;查詢數(shù)據(jù)，比如：selectUser();save*;保存新修改數(shù)據(jù)，效果跟insert方法一樣；比如：saveUser();6.注釋原則
6、【建議-1】在代碼中盡量使用“//”風格的注釋，而不提倡使用“/*...*/”的注釋（除非注釋比較多或有規(guī)范要求的）。這樣可以允許使用“/*...*/”來把大范圍的代碼轉換為注釋?！疽?guī)則-2】注釋應當準確、易懂，防止有二義性。錯誤的注釋不但無益反而有害【規(guī)則-3】邊寫代碼邊注釋，修改代碼同時修改相應的注釋，以保證注釋與代碼的一致性。不再有用的注釋要及時刪除?！疽?guī)則-4】注釋是對代碼邏輯的描述，而不是文檔或代碼的翻譯。程序中的注釋不可喧賓奪主，注釋太多了會讓人眼花繚亂?！疽?guī)則-5】類的注釋：a.類是誰寫的;b.類的功能有哪些；c.類的名稱如：/***類名稱*類的簡要描述：*@a
7、uthorChenGangWei*/【規(guī)則-6】方法的注釋：a.方法的功能說明。行的注釋：a.字段的名字必須用意義，字段必須有注釋。b.重要的行必須有注釋。如：/***方法名：*方法簡要描述：*方法詳細描述：（可選，有必要時寫）*@param參數(shù)：*@return返回值：*/【規(guī)則-7】每一個代碼“段”必須要有注釋?！疽?guī)則-8】注釋采用中文，盡量避免在注釋中使用縮寫，特別是不常用縮寫。7．數(shù)據(jù)庫數(shù)據(jù)命名原則【規(guī)則-1】表的命名：TBL_+表名；【規(guī)則-2】表中的字段：表名的首字母+字段；字段名應盡量使用
