【正文】 JAVA 代碼規(guī)范 1 JAVA 代碼規(guī)范(初稿 ) JAVA 代碼規(guī)范 2 ?版本更新信息本版本創(chuàng)建/修改、維護、批準涉及人員如下：創(chuàng)建/修改者：XX維護者：XX批準者：XX具體版本更新記錄如表 11：表 11 版本更新記錄版本號 修改確認日期修改人 修改位置 修改方式（AMD）修改內(nèi)容概述 全部 A 初始版本發(fā)布修改方式：A－增加 M－修改 D－刪除 JAVA 代碼規(guī)范 3 ? 目的本文提供一整套編寫高效可靠的 Java 代碼的標準、約定和指南。它們以安全可靠的軟件工程原則為基礎(chǔ)，使代碼易于理解、維護和增強靈活性。通過遵循一套通用的程序設(shè)計標準，顯著提高 Java 軟件開發(fā)者的生產(chǎn)效率，為開發(fā)團隊的程序設(shè)計帶來更大的一致性，使軟件開發(fā)團隊的效率明顯提高。? 規(guī)范的執(zhí)行本文檔適用于公司內(nèi)進行軟件開發(fā)的所有技術(shù)人員，即公司內(nèi)軟件開發(fā)人員編寫的所有源代碼都必須遵循本規(guī)范。除臨時性項目之外的任何項目均應(yīng)嚴格按照此標準執(zhí)行， “臨時性項目”指：? 為市場推廣目的而編寫的示程序? 為一次性用途而編寫的臨時性小程序為學(xué)習目的而編寫的測試程序? 文檔類別本文檔屬標準規(guī)范類的項目限制級文檔，未經(jīng)總經(jīng)理及總經(jīng)理授權(quán)人員批準，不得提供公司以外的人員閱讀和使用。? 版本更新條件本文檔的定期評審時間為每年的 1 月，評審及修訂步驟依據(jù) SEPG 工作規(guī)范規(guī)定。此外，如遇下列條件可進行評審，并根據(jù)評審結(jié)果決定是否需要進行修訂：? 本文檔所列的引用的標準已經(jīng)更新。? 本文檔的使用者若對本文檔有任何評論、建議或意見，請通過企業(yè)內(nèi)部網(wǎng)絡(luò)發(fā)電子郵件給 SEPG，所收到的電子郵件將會在評審和修訂時給予充分的考慮。? 使用對象本文檔的使用對象包括：? 項目管理者? 質(zhì)量保證人員? 軟件開發(fā)人員 JAVA 代碼規(guī)范 4 目 錄1 介紹 ..............................................................................................................................................7 為什么要有編碼規(guī)范 ..........................................................................................................72 通用代碼格式 ..............................................................................................................................7 文件組織 ..............................................................................................................................7 縮進 ......................................................................................................................................8 行長度 ..................................................................................................................................8 換行 ......................................................................................................................................8 空行 ....................................................................................................................................10 空格 ....................................................................................................................................10 注釋 ....................................................................................................................................11 注釋約定 ....................................................................................................................11 實現(xiàn)注釋的格式 ........................................................................................................12 文檔注釋 ....................................................................................................................13 快速瀏覽 javadoc......................................................................................................13 聲明 ....................................................................................................................................14 每行聲明變量的數(shù)量 ................................................................................................14 初始化 ........................................................................................................................14 布局 ............................................................................................................................15 類和接口的聲明 ........................................................................................................15 語句 ....................................................................................................................................16 簡單語句 ....................................................................................................................16 復(fù)合語句 ....................................................................................................................16 返回語句 ....................................................................................................................16 if， ifelse， if elseif else 語句 ...................................................................................16 for 語句 .......................................................................................................................17 while 語句 ...................................................................................................................17 dowhile 語句 .............................................................................................................17 switch 語句 .................................................................................................................17 trycatch 語句 .............................................................................................................18 SQL.....................................................................................................................................183 命名規(guī)范 ....................................................................................................................................19 總則 ....................................................................................................................................19 項目命名 ............................................................................................................................19 命名規(guī)則 ............................................................................................................................20 變量命名機制 ....................................................................................................................20 基本類型變量命名規(guī)則：變量類型標識 +邏輯名 ....