某Java編碼規(guī)范和公司治理的核心原則

Java編碼規(guī)范修訂歷史記錄日期版本說明作者審核人2011-7-110.0.1對Java代碼風格、注釋、命名、聲明等規(guī)范進行描述黎建寧2011-8-50.0.2根據征詢意見對Java編碼規(guī)范進行修訂黎建寧、馮彬杰、張史沛、李思行2011-8-0.0.對規(guī)范中出現(xiàn)模糊定義的地方進行細化描述黎建寧2011-0.0.4根據編碼的約定情況，對注釋、聲明部分進行了補充黎建寧、李思行2011-0.0.對方法的聲明順序進行補充黎建寧、李思行一簡介1目的本規(guī)范的目的是使開發(fā)人員以標準的、規(guī)范的方式編寫代碼，養(yǎng)成良好的編碼風格和習慣，形成公司內部編碼約定，提高程序的可讀性，可維護性以及一致性，同時減少項目組成員間技術溝通成本，提高團隊開發(fā)效率。2范圍1、本文檔基于Java1.5的語法描述編碼規(guī)范。2、本文檔從代碼風格、注釋、命名、聲明以及異常處理等五個方面對Java編碼進行約定。3、本規(guī)范適用于所有運用Java技術的軟件項目、產品。4、本規(guī)范適用的文件類型包括但不限于Java源文件、JSP文件、XML文件、HTML文件、JS文件以及AS文件。5、本規(guī)范建議采用統(tǒng)一的CodeStyle以及Formatter風格，通過IDE進行配置。3讀者范圍1、軟件過程改進領導小組以及工作小組所有人員；2、所有運用Java技術的軟件項目、產品的相關領導、項目負責人、設計人員、開發(fā)人員以及測試人員。3、所有涉及運用Java技術的軟件項目、產品的相關人員。二代碼風格1縮進1、使用空格代替Tab縮進，避免各種編輯器中看到不一樣的代碼格式?！咀ⅲ簭娭茍?zhí)行，Eclipse可輔助排版】2、代碼按層級縮進，每層級縮進4個字符（對于特定格式文件，可以按照實際進行調整，如XML文件可縮進2個字符），所有“｛｝”塊內容都應該進行縮進。【注：強制執(zhí)行，Eclipse可輔助排版】參考例子：2括號1、除數(shù)組的初始化定義外，“｛｝”中的語句應單獨作為一行。?！咀ⅲ簭娭茍?zhí)行，Eclipse可輔助排版】2、左括號“｛”可根據開發(fā)習慣是否換行存放，如果換行存放，必須與其前導語句首字符對齊，右括號“｝”必須作為單獨一行存放并且與匹配行對齊（即左括號前導語句首字符）。。【注：強制執(zhí)行，Eclipse可輔助排版】3、在項目內部，相同類型的文件，其括號的風格必須統(tǒng)一。?！咀ⅲ簭娭茍?zhí)行，Eclipse可輔助排版】參考例子：3空格1、操作符兩端必須帶有空格符。【注：強制執(zhí)行，Eclipse可輔助排版】參考例子： 2、各并行元素（如函數(shù)參數(shù)）間以空格符隔開，空格符放在逗號后方。參考例子：【注：強制執(zhí)行，Eclipse可輔助排版】3、無特別要求，括號“{}”、“[]”、“()”左右方盡量不要增加無必要性的空格符?！咀ⅲ簭娭茍?zhí)行，Eclipse可輔助排版】參考例子：4空行1、同一個編譯單元間（包定義、導入聲明、類）應以空行相隔。參考例子：【注：強制執(zhí)行，Eclipse可輔助排版】2、類定義內部各元素間（字段定義、方法）應以空行相隔。參考例子：【注：強制執(zhí)行，Eclipse可輔助排版】3、同一方法內實現(xiàn)不同的功能之間應以空行相隔?！咀ⅲ簭娭茍?zhí)行】4、不能無理由出現(xiàn)大片空行?！咀ⅲ簭娭茍?zhí)行】5控制語句1、對于循環(huán)控制等元素塊，不管是否帶有body，都應該以{}包含。參考例子：【注：強制執(zhí)行】6行寬1、每行代碼盡量控制行寬在100字以內，當超出100字時候，代碼應當進行縮進。【注：非強制執(zhí)行，屬加分項】2、方法的縮進應當保證參數(shù)對齊?！咀ⅲ悍菑娭茍?zhí)行，屬加分項】參考例子：3、對于過長的SQL/HQL語句，則采用關鍵字對齊方式，具體可通過PL/SQL等工具進行代碼的格式化?！咀ⅲ悍菑娭茍?zhí)行，屬加分項，附帶《sql規(guī)范》一并考核】參考例子：7類、函數(shù)1、每個函數(shù)的代碼長度應盡量控制在50行以內（不包含注釋），如果函數(shù)功能過于龐大，可把獨立的功能段單獨抽取出來作為子函數(shù)?！咀ⅲ悍菑娭茍?zhí)行，屬加分項】2、每個類的代碼長度應盡量控制在1000行以內（不包含注釋），如果類功能過于龐大，可通過組合的方式來分解類。【注：非強制執(zhí)行，屬加分項】三注釋1基本原則1、注釋目的在于增加代碼清晰度，使代碼易于被其他開發(fā)人員理解?！咀ⅲ簭娭茍?zhí)行】2、保持注釋簡潔，禁止為了注釋而注釋。【注：強制執(zhí)行】3、注釋除帶有代碼功能外，還應帶有描述上下文意圖，具體描述其原因。4、除變量定義等較短語句的注釋可用行尾注釋外，其他注釋當避免使用行尾注釋。5、對描述較長的注釋，應當使用HTML標記進行格式化，便于生成的JavaDoc易閱讀和理解?！咀ⅲ簭娭茍?zhí)行】2文件、包1、文件、包頭部應當帶有注釋，描述其功能、作用、作者、創(chuàng)建時間、修改歷史等信息。【注：非強制執(zhí)行，屬加分項】參考例子：3類、接口1、對類、接口的注釋應當符合JavaDoc規(guī)范?！咀ⅲ簭娭茍?zhí)行】2、類、接口定義必須標記功能、作用、作者、時間?！咀ⅲ簭娭茍?zhí)行】3、當代碼基線定義后，后續(xù)維護中新增的方法或字段在類、接口聲明頭部中應當添加修訂記錄，注明時間、原因以及作者。【注：非強制執(zhí)行，屬加分項】參考例子：4方法1、對方法的注釋應當符合JavaDoc規(guī)范?！咀ⅲ簭娭茍?zhí)行】2、方法定義應帶有功能、作用、執(zhí)行條件（如果有）、參數(shù)，對于復雜功能的方法，應當帶有例子描述?！咀ⅲ汗δ?、作用、執(zhí)行條件（如果有）、參數(shù)屬強制執(zhí)行；例子描述屬非強制執(zhí)行，屬加分項】3、每個方法中含有的參數(shù)以及返回值應當描述其類型、作用、值的范圍，對方法的影響。【注：強制執(zhí)行】4、當方法拋出自定義的受控異常（CheckedException，不含工具、框架拋出的異常）時，必須對異常產生的原因進行描述，便于調用者捕捉?！咀ⅲ簭娭茍?zhí)行】參考例子：5、對規(guī)范中約定的方法，如回調方法、getter/setter方法，只要遵守其命令約定，均不需要編寫注釋?！咀ⅲ悍菑娭茍?zhí)行】參考例子：6、如果方法內部涉及復雜的算法、關鍵步驟或難以理解的語句，應當添加注釋標明其含義?！咀ⅲ悍菑娭茍?zhí)行，屬加分項】7、對于超過一行注釋，必須采用“/**/”進行標注，而單行注釋可采用“//”標注?！咀ⅲ簭娭茍?zhí)行】5變量1、全局變量、靜態(tài)變量、類中的字段應當帶有注釋。【注：強制執(zhí)行】參考例子：2、對規(guī)范中約定的變量，如注入對象（如Service、DAO），通訊對象（如RemoteObject），只要遵守其命令約定，均不需要編寫注釋?！咀ⅲ悍菑娭茍?zhí)行，屬加分項】參考例子：3、對于方法內部產生的臨時變量，應當盡量添加注釋，標明其中的作用。四命名1基本原則1、文件，類，函數(shù)，變量，命名必須采用可準確表達其意義的英文單詞。2、命名不能和關鍵字相同?！咀ⅲ簭娭茍?zhí)行】3、盡量避免使用出現(xiàn)誤解的詞匯。4、不允許使用拼音命名，全部使用英文單詞或縮寫命名。【注：強制執(zhí)行】2文件、包1、文件名第一字母應大寫。【注：強制執(zhí)行】2、文件名應盡量描述該文件作用?！咀ⅲ悍菑娭茍?zhí)行，但采用拼音命名需扣分】3、文件名應使用名詞或形容詞＋名詞?！咀ⅲ簭娭茍?zhí)行】4、包名一般以項目或模塊名進行命名，采用小寫?！咀ⅲ簭娭茍?zhí)行】5、包名組成規(guī)則[基本包].[項目名].[模塊名].[子模塊名]...【注：強制執(zhí)行】參考例子：6、禁止把類直接定義在默認包下。以下行為必須禁止：【注：強制執(zhí)行】3類、接口1、類、接口名第一字母應大寫?！咀ⅲ簭娭茍?zhí)行】2、類名應盡量描述該類作用?！咀ⅲ簭娭茍?zhí)行】3、類名應使用名詞或形容詞＋名詞?！咀ⅲ簭娭茍?zhí)行】4、如果需要用到多個單詞表達其意義，每個單詞第一個字母必須用大寫標識。【注：強制執(zhí)行】參考例子：5、類名不使用下劃線?！咀ⅲ簭娭茍?zhí)行】6、如果用到某些特定名詞作為類名，應保持該特定名詞，如“ADOHelper”?！咀ⅲ簭娭茍?zhí)行】7、接口的第一個字母應為“I”，其他命名規(guī)則與普通類名相同?！咀ⅲ簭娭茍?zhí)行】8、對于DAO類，其命名規(guī)則為：名詞+“DAO”，對于應用服務類，其命名規(guī)則為：名詞+“Service”。【注：強制執(zhí)行】9、如果類為持久類，需要與數(shù)據庫表進行綁定的，其命名在忽略前綴以及下劃線等特殊字符的情況下，應與數(shù)據庫表名保持一致?！咀ⅲ簭娭茍?zhí)行】以下行為必須禁止：4字段1、字段名第一字母應小寫?！咀ⅲ簭娭茍?zhí)行】2、字段名應盡量描述該字段的作用?！咀ⅲ簭娭茍?zhí)行】3、字段名應使用名詞或形容詞＋名詞?！咀ⅲ簭娭茍?zhí)行】4、如果需要用到多個單詞表達其意義，除第一個字母外，每個單詞第一個字母必須用大寫標識?！咀ⅲ簭娭茍?zhí)行】5、如果字段所在類為持久類，需要與數(shù)據庫表進行綁定的，其命名在忽略前綴以及下劃線等特殊字符的情況下，應與數(shù)據庫字段名保持一致?！咀ⅲ簭娭茍?zhí)行】5方法1、方法名第一字母應小寫?！咀ⅲ簭娭茍?zhí)行】2、方法名應盡量描述該方法的作用?！咀ⅲ簭娭茍?zhí)行】3、方法名應使用“動詞＋名詞”形式命名。【注：強制執(zhí)行】4、如果需要用到多個單詞表達其意義，除第一個單詞外，其他單詞第一個字母必須用大寫標識?！咀ⅲ簭娭茍?zhí)行】5、對于常用的DAO查詢方法，方法應當表明方法出處、數(shù)據的來源以及查詢依據。如getOrderListByCustomer方法根據顧客獲取訂單列表，此方法由Order模塊提供而不是Customer模塊?！咀ⅲ海?）強制執(zhí)行，但條件定義為非強制執(zhí)行，即getOrderListByCustomer中的ByCustomer為非強制執(zhí)行】6、回調方法應使用“Callback”作為方法后綴，如非特殊回調方法，可采用“調用方法+Callback”命名規(guī)則，如login方法回調，其方法命名為loginCallback。【注：強制執(zhí)行】7、Flex各種事件，采用“on”作為方法前綴命名，如非特殊事件，可采用“on+方法名”命名規(guī)則，如createComplete事件中，其方法命名為onCreateComplete，如果存在多個相同的事件，采用“on+組件ID+方法名”命名規(guī)則?！咀ⅲ簭娭茍?zhí)行】6變量1、變量名第一字母應小寫。【注：強制執(zhí)行】2、變量名應盡量描述該變量的作用。3、變量名一般使用“形容詞＋名詞”或單個名詞，布爾變量應使用含有“判斷意義的單詞＋名詞”，例如判斷是否已關閉的變量：booleanisClosed，禁止聲明類似aaa、bb無法定義、理解的變量。【注：強制執(zhí)行】4、如果需要用到多個單詞表達其意義，除第一個單詞外，其他單詞第一個字母必須用大寫標識。【注：強制執(zhí)行】5、用于for循環(huán)的局部變量可使用i等單個字母?！咀ⅲ悍菑娭茍?zhí)行】7常量1、常量名應盡量描述該常量的作用?！咀ⅲ悍菑娭茍?zhí)行，但采用拼音命名需扣分】2、常量名一般使用“形容詞＋名詞”或單個名詞?！咀ⅲ簭娭茍?zhí)行】3、如果需要用到多個單詞表達其意義，單詞間應通過“_”分割?！咀ⅲ簭娭茍?zhí)行】參考例子：8組件變量1、組件變量符合變量命名規(guī)則。【注：強制執(zhí)行】2、組件變量名一般采用組件前綴+變量名命名?！咀ⅲ簭娭茍?zhí)行,表單內的組件變量非強制執(zhí)行】3、一般情況下，組件前綴可采用組件縮寫（見本章第9節(jié)Flex命名約定表）或全名表示，但對于過長的組件命名，建議采用縮寫標識。（新增的必須執(zhí)行）【注：強制執(zhí)行，因考慮其對舊項目的改動性太大，故該考核只針對新增的代碼模塊,其中Flex命名約定表里的組件若需要縮寫標識,則必須是Flex命名約定表中對應的縮寫標識】4、對于某些顯示數(shù)據庫字段的控件，其變量名應對應數(shù)據庫字段名?！咀ⅲ簭娭茍?zhí)行】9附Flex命名約定表組件全名組件名稱縮寫Controls類：AdvancedDataGridadgAlertalButtonbtnCheckBoxchkColorPickercrpComboBoxcmbDataGriddgDateChooserdcDateFielddfHSliderhslHorizontalListhorlstImageimgLabellblLinkButtonlnkbtnListlstNumericSteppernsOLAPDataGridodgPopUpButtonpubPopUpMenuButtonpumbProgressBarprgRadioButtonrdoRadioButtonGrouprdogRichTextEditorrtxSWFLoaderswflTexttxTextAreatxaTextInputtxiTileListtltTreetreVSlidervslVideoDisplayvdpLayout類：ApplicationControlBaracbCanvascvsControlBarctbFormfmFormHeadingfmhGridgdHBoxhbHDividedBoxhdbHrulehrModuleLoadermdlPanelpnlSpacerspcTiletilTitleWindowtilwVBoxvbVDividedBoxvdbVRulevrNavigators類：AccordionaodButtonBarbtnbLinkBarlkbrMenuBarmnbTabBartabTabNavigatortbnToggleButtonBartbbViewStackvskCharts類：AreaChartarecBarChartbarcBubbleChartbubcCandlestickChartcancColumnChartcolcHLOCCharthloccLegendlgdLineChartlincPieChartpiecPlotChartploc自定義組件根據基礎組件進行自定義組合注意：基于約定優(yōu)于配置原則，若規(guī)范中定義的命名規(guī)則與組件約定的規(guī)則存在沖突，以組件約定的規(guī)則為優(yōu)先。參考例子：五聲明1類、接口1、可見性必須顯式聲明。【注：強制執(zhí)行】2方法1、可見性必須顯示聲明?！咀ⅲ簭娭茍?zhí)行】2、盡可能減少類與類之間耦合，盡量限制成員函數(shù)的可見性（不要擴大其可見范圍）。【注：非強制執(zhí)行，屬加分項】3、如果存在多個參數(shù)，按照功能的相似性，應放到一齊?！咀ⅲ簭娭茍?zhí)行】4、對于同樣可見性的方法，按照功能的相似性，應放到一齊。（如as中應當將事件、回調方法、引用方法區(qū)分存放）?！咀ⅲ簭娭茍?zhí)行】5、對于重載的方法，按參數(shù)的個數(shù)，從少到多排序?！咀ⅲ簭娭茍?zhí)行】6、方法按照其屬性以及可見性，按以下順序排序：構造方法、靜態(tài)公共方法、靜態(tài)私有方法、受保護方法、私有方法、以及繼承自Object的方法（as代碼按照實際情況進行調整）?！咀ⅲ簭娭茍?zhí)行】7、方法的聲明順序按照以下優(yōu)先級聲明：功能相似性---》可見性---》參數(shù)個數(shù)列子：publicvoidsaveUser(Useruser)

publicvoidsaveUser(Useruser,LongorgId)

publicvoidsaveUsers(List<User>user,LongorgId,LongstationId)

privatevoidsaveUsers(List<User>user)【注：強制執(zhí)行】3字段1、不要把字段聲明為公有，應當設置為私有，通過getter以及setter訪問（僅針對Java）。【注：強制執(zhí)行】2、非同級變量不能使用一樣或者相近的名字。如five、fine?！咀ⅲ簭娭茍?zhí)行】3、變量按照其屬性以及可見性，按以下順序排放：常量、類變量、實例變量、公有字段、受保護字段、私有字段、可以將私有變量聲明在類或接口的最后（as代碼按照實際情況進行調整）?！咀ⅲ簭娭茍?zhí)行】4、字段應通過this、super顯式調用?！咀ⅲ簭娭茍?zhí)行】4變量1、方法中的變量在聲明時必須帶有初始值，對于無法初始化的變量，可定義為null（不含字段）。【注：強制執(zhí)行】2、變量應在其使用時進行定義，減少變量作用域以及作用范圍，禁止變量定義后沒有使用?！咀ⅲ悍菑娭茍?zhí)行，但出現(xiàn)定義的變量沒有使用這種情況，需要扣分】六異常處理1、凡涉及到創(chuàng)建實例，使用數(shù)據庫對象，使用事務對象，使用COM+對象，使用線程對象，操作網絡連接等代碼，均應使用“try-catch”對或throws命令?！咀ⅲ簭娭茍?zhí)行】2、凡涉及代碼可能拋出異常的，均應使用“try-catch”對或throws命令?！咀ⅲ簭娭茍?zhí)行】3、捕捉CheckedException類異常（直接集成自Exception）時，必須輸出詳細錯誤信息，如堆棧信息，并進行日志記錄?！咀ⅲ簭娭茍?zhí)行】

公司治理的核心原則黃一義

編譯什么是公司治理？

公司治理是調整公司企業(yè)各方參與者關系的規(guī)范，這些參與者主要包括三個方面：股東；（以CEO為首的）公司管理層；董事會及其成員。這些參與者決定著公司的發(fā)展方向和績效。公司治理結構的目標是要在這三方面參與者之間建立起兩種有效的負責任（accountable）的關系，即董事會對管理層的有效監(jiān)督和股東對董事會的有效制約。經驗表明，股東積極行使其所有者權力參與公司事務，會使公司管理層更加負責且更加關注公司的業(yè)績，因而對股東的投資帶來更多的回報。美國的一家大型信托機構棗擁有1000多億美元資產的加州雇員退休系統(tǒng)1996年的一項研究表明，這種積極的參與使美國公司新增利潤達1.5億美元。公司治理的核心原則

公司治理的核心原則對維持一個公開、公平的資本市場是必須的，是資本市場吸引投資者的廣泛參與并保持其競爭力和吸引力的重要規(guī)范。它包含如下要點：可信賴性（Accountability）對股東的義務公司董事會和管理層必須對股東負責。尤其是公司董事在以下幾方面有特殊的責任：（1）樹立公司的戰(zhàn)略觀念，以確保股東長期價值的增加成為公司的首要考慮；（2）依據第一項要求，對其自身以及公司管理班子的績效進行持續(xù)的評估。對股東提出的關于公司狀況和管理層績效的問題，董事會和管理層應該保持開放性并使之易于得到解答，董事會應當向市場披露其做出一些重大決定的方式，這些決定涉及公司經理的薪酬如何確定，公司的戰(zhàn)略規(guī)劃，新董事的提名和公司經理人員的任命和考核等。新董事侯選人的背景，包括其與公司的經濟關系也應向公司股東披露。監(jiān)督董事會應當具有對公司管理層進行有效監(jiān)督的能力，股東對董事會應具有同樣的能力。為此，股東應能通過適當?shù)耐镀背绦蛐惺蛊錂嗔?。經理的薪酬建立可信賴性的一種最有效的方法是使經理人員的利益與股東的利益保持一致。管理層的薪酬應與公司的長期業(yè)績表現(xiàn)掛鉤。透明度公開性一個自由、有效的具有全球競爭力的資本市場必須建立在公開性的基礎上。如果一個市場不能使投資者對其公開性具有信心，投資者就會退出這一市場。會計準則目前不同的市場采用不同的會計準則，這使國際投資者的有效分析難以進行。公司應努力采用國際會計準則。一致性報告在某些市場一些機構頒布“最佳行為準則”作為一種標準的公司治理規(guī)范。在采納這些準則的市場，公司應向股東報告其是否遵守這些準則，并說明其不遵守的理由。公平公平對待在所有的市場對所有的股東均應以公平相待的方式一視同仁，包括外國股東在內。公司應特別注意尊重少數(shù)股東的利益，并且不采取對投資者具有實質性損害的行為。一股一票一般說來，每一股應使其持有者在股東大會上享有其相應的一份投票權。選舉方法代理資料代理資料應當簡潔、明確，并包含有能使股東對有關問題做出知情決定的適當信息。此外，代理資料的發(fā)放應采取鼓勵而不是抑制股東參與的方式進行，這一要求包括對會議和投票日期的適當選擇。計票所有的股東選票，不論是以本人投票或通過代理的方式投票，均應正規(guī)地予以統(tǒng)計，并將其結果正式地宣布。相反的做法意味著對一部分股東授予特權，并且不利于公司管理層準確地了解全體股東的愿望和要求。技術只要有可能，各公司均應采用新技術以使代理投票的過程更方便、更有效且更節(jié)省。最佳行為準則建立準則各國資本市場均應建立適當?shù)摹白罴研袨闇蕜t”，使公司的董事和經理人員能據此對自身的行為進行規(guī)范，并使其明確其與股東的關系及其對股東負有的責任。這一準則體現(xiàn)了一種標準，它來自于最優(yōu)秀的公司治理的實踐。一旦“最佳公司行為準則”建立起來，公司應當遵守這一準則并向股東報告其對這一規(guī)則的任何違反行為。評估和改進市場的各方參與者是應對這一準則進行評估以確保其具有全球競爭力。長期觀點

公司董事和管理層應具備長期的戰(zhàn)略設想，以保證股東價值的增加。盡管不同的投資者采用不同的投資策略，并具有不同的投資強度，投資者仍應鼓勵公司管理者抵御短期行為，在關鍵的時刻對管理者提供支持，并對其使公司成功地產生長期超額回報的業(yè)績予以獎賞。附1首席獨立董事的職務責任·首席執(zhí)行官（CEO）是公司的最高行政負責人，其職責為：*對公司的日常事務進行管理；*制定和提出公司政策和戰(zhàn)略方向的建議供董事會最終批準；*充當公司的發(fā)言人?！づc此相對照，首席獨立董事負責協(xié)調獨立董事們的各項活動，除了董事的一般職責以外，首席獨立董事的特殊職責包括：*就董事會的日程向董事長提出適當?shù)慕ㄗh，要求能夠確保獨立董事負責任地行使其職責