某有限公司java編碼規(guī)范(編輯修改稿)
2025-05-06 01:06 本頁面
【文章內容簡介】 文件，類，函數，變量，命名必須采用可準確表達其意義的英文單詞。命名不能和關鍵字相同?！咀ⅲ簭娭茍?zhí)行】盡量避免使用出現誤解的詞匯。不允許使用拼音命名，全部使用英文單詞或縮寫命名?！咀ⅲ簭娭茍?zhí)行】2 文件、包文件名第一字母應大寫。【注：強制執(zhí)行】文件名應盡量描述該文件作用?！咀ⅲ悍菑娭茍?zhí)行，但采用拼音命名需扣分】文件名應使用名詞或形容詞＋名詞?！咀ⅲ簭娭茍?zhí)行】包名一般以項目或模塊名進行命名，采用小寫?！咀ⅲ簭娭茍?zhí)行】包名組成規(guī)則[基本包].[項目名].[模塊名].[子模塊名]... 【注：強制執(zhí)行】參考例子：禁止把類直接定義在默認包下。以下行為必須禁止：【注：強制執(zhí)行】3 類、接口類、接口名第一字母應大寫?！咀ⅲ簭娭茍?zhí)行】類名應盡量描述該類作用?！咀ⅲ簭娭茍?zhí)行】類名應使用名詞或形容詞＋名詞。【注：強制執(zhí)行】如果需要用到多個單詞表達其意義，每個單詞第一個字母必須用大寫標識?！咀ⅲ簭娭茍?zhí)行】參考例子：類名不使用下劃線?！咀ⅲ簭娭茍?zhí)行】如果用到某些特定名詞作為類名，應保持該特定名詞，如“ADOHelper”?！咀ⅲ簭娭茍?zhí)行】接口的第一個字母應為“I”，其他命名規(guī)則與普通類名相同?！咀ⅲ簭娭茍?zhí)行】對于DAO類，其命名規(guī)則為：名詞+“DAO”，對于應用服務類，其命名規(guī)則為：名詞+“Service”。【注：強制執(zhí)行】如果類為持久類，需要與數據庫表進行綁定的，其命名在忽略前綴以及下劃線等特殊字符的情況下，應與數據庫表名保持一致?！咀ⅲ簭娭茍?zhí)行】以下行為必須禁止：4 字段字段名第一字母應小寫?！咀ⅲ簭娭茍?zhí)行】字段名應盡量描述該字段的作用?！咀ⅲ簭娭茍?zhí)行】字段名應使用名詞或形容詞＋名詞?！咀ⅲ簭娭茍?zhí)行】如果需要用到多個單詞表達其意義，除第一個字母外，每個單詞第一個字母必須用大寫標識?！咀ⅲ簭娭茍?zhí)行】如果字段所在類為持久類，需要與數據庫表進行綁定的，其命名在忽略前綴以及下劃線等特殊字符的情況下，應與數據庫字段名保持一致?！咀ⅲ簭娭茍?zhí)行】5 方法方法名第一字母應小寫?！咀ⅲ簭娭茍?zhí)行】方法名應盡量描述該方法的作用?！咀ⅲ簭娭茍?zhí)行】方法名應使用“動詞＋名詞”形式命名?！咀ⅲ簭娭茍?zhí)行】如果需要用到多個單詞表達其意義，除第一個單詞外，其他單詞第一個字母必須用大寫標識?！咀ⅲ簭娭茍?zhí)行】對于常用的DAO查詢方法，方法應當表明方法出處、數據的來源以及查詢依據。如getOrderListByCustomer方法根據顧客獲取訂單列表，此方法由Order模塊提供而不是Customer模塊?！咀ⅲ海?）強制執(zhí)行，但條件定義為非強制執(zhí)行，即getOrderListByCustomer中的ByCustomer為非強制執(zhí)行】回調方法應使用“Callback”作為方法后綴，如非特殊回調方法，可采用“調用方法+Callback”命名規(guī)則，如login方法回調，其方法命名為loginCallback。【注：強制執(zhí)行】Flex各種事件，采用“on”作為方法前綴命名，如非特殊事件，可采用“on+方法名”命名規(guī)則，如createComplete事件中，其方法命名為onCreateComplete，如果存在多個相同的事件，采用“on+組件ID+方法名”命名規(guī)則。【注：強制執(zhí)行】6 變量變量名第一字母應小寫?！咀ⅲ簭娭茍?zhí)行】變
公司管理相關推薦
鄂ICP備17016276號-1