posts - 12, comments - 4, trackbacks - 0, articles - 0

          代碼規范(轉)

          Posted on 2007-10-31 17:27 Edward's 閱讀(319) 評論(0)  編輯  收藏 所屬分類: 代碼規范

          1. 每個文件的頭部注釋: 版權說明、版本號、生成日期、作者、內容、功能、與其它文件的關系、修改日志等,頭文件的注釋中還應有函數功能簡要說明;

          2. 函數頭部應進行注釋:函數的目的/功能、輸入參數、輸出參數、返回值、調用關系(函數、表)、作者或修改人等;

          3. 對變量的定義和分支語句(條件分支、循環語句等)必須編寫注釋;

          4. 自己特有的命名風格,要自始至終保持一致,不可來回變化;

          5. 類命名標準: 由兩個或以上的相近意義的英文單詞組成,首字母大寫;

          6. 一個類里面只能實現一個單據或一個功能的不同操作方面,盡可能減少類之間的耦合性;

          7. 一些通用功能,都分類封裝成不同的實用操作類;

          8. 對以前的對象或函數重構或重命名時, 必須由修改人搜索以前的所有調用并替換,同時通知其它人以后使用新的調用;

          9. 注釋格式 /** * Setting to true will enable the display of debug information. * * @param d A boolean. * @return An Email. * @throws EmailException * @version Version * @author Author * @since 1.0 */

          10. 類包規范: path.crm(itm,system,basic,oa,wms,mrp,scm).entity(manager),按模塊分開類,同時實體類與操作類分開,映射文件跟實體類同目錄;path.util下為實用類;Servlet映射為二級目錄,目前為/path/system;

          11. 頁面不允許RS對象引用,全部用List或HashMap來實現;

          12. 參數傳遞盡可能使用實體類, 沒有實體類的使用HashMap;

          13. 方法重載時, 可替換的不能使用重載;

          14. 嚴格按照代碼縮進格式進行代碼書寫,包括各種操作與分隔符號兩邊的空格;

          15. 模糊搜索關鍵字,可以輸入如"ab,abc"以逗號分隔的多個關鍵字進行搜索;

          16. 變量命名規則: 數據類型簡寫+首字母大寫的變量英文名稱, 如果是全局變量加上小寫g, 如: gszLimitString, gnModuleFlag, gnPageSize;

          17. 程序中,SQL語句不能包含方括號, SQL語句中的表別名不能加AS,用空格代替;

          18. SQL字符串,不能直接拼接字符串變量,用SET方法實現變量賦值,避免非法字符串變量引起安全問題;

          19. 必須隨時關閉所用的ResultSet,Statement對象,最好用finally實現,避免錯誤時沒有關閉的問題;

          20. 附件管理: 文件大小統一用text.formatFileSize()進行格式化;查看與下載鏈接用SPAN標簽;

          21. 其它詳細的請參見公司的“軟件編程規范檢查”;

           

          ps:Java語言編碼規范(Java Code Conventions):

          http://www.huihoo.org/code/java_code_conventions.html


          只有注冊用戶登錄后才能發表評論。


          網站導航:
           
          主站蜘蛛池模板: 南木林县| 若尔盖县| 修武县| 吉木萨尔县| 大石桥市| 海宁市| 昌平区| 阜南县| 政和县| 靖江市| 罗平县| 景德镇市| 延寿县| 海兴县| 夏河县| 五莲县| 太原市| 海口市| 朝阳县| 齐河县| 怀化市| 夹江县| 财经| 馆陶县| 朝阳县| 南陵县| 枣庄市| 柳江县| 禄劝| 高台县| 明星| 盈江县| 西青区| 五寨县| 塘沽区| 宣汉县| 鱼台县| 云和县| 布尔津县| 禄丰县| 理塘县|