資源描述:
《java開發(fā)規(guī)范文檔》由會(huì)員上傳分享,免費(fèi)在線閱讀,更多相關(guān)內(nèi)容在教育資源-天天文庫(kù)。
1、一千零一夜產(chǎn)品部系統(tǒng)開發(fā)規(guī)范V1.0一千零一夜途遇科技有限公司2015-11-03修改記錄版本號(hào)修改人修改內(nèi)容V1.0劉偉規(guī)范第一版目錄1前言42開發(fā)管理43項(xiàng)目周期44命名規(guī)范54.1項(xiàng)目編號(hào)命名規(guī)范54.2文檔命名規(guī)范54.3路徑管理54.4jsp/html命名規(guī)范64.5數(shù)據(jù)庫(kù)命名規(guī)范84.5.1表名規(guī)范84.5.2字段規(guī)范85文檔規(guī)范96代碼規(guī)范96.1Java源代碼規(guī)范96.1.1命名96.1.2代碼格式116.1.3注釋136.1.4其他136.2jsp/html代碼規(guī)范136.3數(shù)據(jù)庫(kù)開發(fā)
2、規(guī)范156.3.1主鍵156.3.2日期類型166.3.3固定字段166.3.4取值規(guī)范176.3.5數(shù)據(jù)庫(kù)開發(fā)工具176.3.6Sql書寫規(guī)范176.4其他規(guī)范177實(shí)戰(zhàn)代碼規(guī)范187.1Java源代碼規(guī)范187.1.1java代碼命名與格式187.2jsp/html代碼規(guī)范268FAQ298.1Logic類中新增數(shù)據(jù)方法怎么寫298.2Logic類中修改數(shù)據(jù)方法怎么寫308.3Logic類中刪除數(shù)據(jù)方法怎么寫318.4怎樣創(chuàng)建一個(gè)沒有底部按鈕的窗口328.5怎樣設(shè)置彈出窗口的標(biāo)題328.6怎樣重寫提
3、交數(shù)據(jù)的方法338.7怎樣創(chuàng)建單grid的頁(yè)面338.8怎樣多個(gè)頁(yè)簽的grid的頁(yè)面348.9怎樣創(chuàng)建左邊樹右邊grid的頁(yè)面349代碼檢查規(guī)定3410附錄1:JPA使用指南javax.persistence的注解配置341前言 為了使軟件開發(fā)過(guò)程有章可循,保證軟件質(zhì)量,加強(qiáng)開發(fā)管理。2開發(fā)管理3項(xiàng)目周期公司項(xiàng)目開發(fā)周期分為以下幾個(gè)步驟:文檔名稱說(shuō)明撰寫人是否可選備注需求分析n完成對(duì)用戶系統(tǒng)的需求分析n對(duì)項(xiàng)目工作量進(jìn)行詳細(xì)評(píng)估,配備相應(yīng)的開發(fā)、測(cè)試、實(shí)施人員n指定項(xiàng)目的開發(fā)計(jì)劃,指定到人需求說(shuō)明書需求分
4、析人員必選根據(jù)項(xiàng)目規(guī)模和要求詳細(xì)程度可以有所不同。Demo各個(gè)模塊的詳細(xì)頁(yè)面Demo開發(fā)人員必選根據(jù)項(xiàng)目規(guī)模和要求詳細(xì)程度可以有所不同。開發(fā)計(jì)劃標(biāo)記各個(gè)模塊的開發(fā)計(jì)劃項(xiàng)目經(jīng)理必選到周,到人測(cè)試計(jì)劃測(cè)試計(jì)劃測(cè)試人員必選根據(jù)項(xiàng)目情況詳細(xì)情況可以不同測(cè)試用例測(cè)試人員可選根據(jù)項(xiàng)目情況選用開發(fā)階段各計(jì)劃階段時(shí)間點(diǎn)的執(zhí)行情況每周進(jìn)行總結(jié)項(xiàng)目執(zhí)行情況說(shuō)明項(xiàng)目經(jīng)理必選項(xiàng)目經(jīng)理填寫標(biāo)準(zhǔn)格式的文檔每周個(gè)人總結(jié)項(xiàng)目組成員必選初期在貴陽(yáng)項(xiàng)目試行系統(tǒng)提交測(cè)試報(bào)告項(xiàng)目階段性提交給項(xiàng)目項(xiàng)目經(jīng)理可選測(cè)試報(bào)告測(cè)試人員實(shí)施階段驗(yàn)收?qǐng)?bào)告項(xiàng)目
5、經(jīng)理必選1命名規(guī)范1.1項(xiàng)目編號(hào)命名規(guī)范1.2文檔命名規(guī)范1.3路徑管理路徑結(jié)構(gòu)如下:項(xiàng)目名稱
6、_database(數(shù)據(jù)庫(kù)數(shù)據(jù))
7、_docs(文檔)
8、_參考文檔(項(xiàng)目參考文件)
9、_需求&設(shè)計(jì)(需求文件及各種設(shè)計(jì)文檔)
10、_開發(fā)計(jì)劃
11、_軟件測(cè)試
12、_部署&培訓(xùn)
13、_工作匯報(bào)
14、_trunk(主目錄)
15、_WebRoot(應(yīng)用文件)
16、_src(源代碼)
17、_業(yè)務(wù)模塊一(某一個(gè)功能分類,如工具類)
18、_com.navinfo.分類英文名(源代碼目錄)
19、
20、_entity(數(shù)據(jù)模型)
21、_logic(邏
22、輯實(shí)現(xiàn)類)
23、_services(邏輯接口層)
24、_action(Action層)
25、_utils(當(dāng)前功能的工具類或常量定義)
26、_
27、_spring/(spring的配置文件)
28、_hibernate/(hibernate的配置文件)
29、_struts/(struts的配置文件)
30、_quartz/(quartz的配置文件)注,紅色字體的部分和原有規(guī)范不同,主要是業(yè)務(wù)模塊和配置文件放在同一個(gè)根目錄下,為防止eclipse的配置順序?qū)е略创a和配置文件分離的很遠(yuǎn)。
31、_業(yè)務(wù)模塊二
32、_......示例:圖:Src
33、路徑1.1jsp/html命名規(guī)范 jsp與html文件名全部小寫,并遵循如下的規(guī)范:數(shù)據(jù)/內(nèi)容顯示頁(yè) 名詞,多個(gè)單詞用下劃線分隔,要求能說(shuō)明顯示內(nèi)容的信息,為避免沖突,可加上"_list"。例如:new_message.html或my_file_list.jsp操作處理頁(yè) 命名格式:名詞_下劃線_動(dòng)詞,例如:file_delete.jsp。圖:Jsp命名含frame頁(yè)面