【文章內(nèi)容簡介】 .............................................................................. 17 一般目的單元 ...................................................................................................... 17 構(gòu)件單元 ............................................................................................................... 17 窗體和數(shù)據(jù)模板 .......................................................................................................................... 17 窗體 .................................................................................................................................... 17 窗體類型命名標(biāo)準(zhǔn) .............................................................................................. 17 窗體實(shí)例命名標(biāo)準(zhǔn) .............................................................................................. 17 自動(dòng)創(chuàng)建窗體 ...................................................................................................... 18 模式窗體實(shí)例化函數(shù) ......................................................................................... 18 數(shù)據(jù)模板 ........................................................................................................................... 19 數(shù)據(jù)模板命名標(biāo)準(zhǔn) .............................................................................................. 19 數(shù)據(jù)模板實(shí)例命名標(biāo)準(zhǔn) ..................................................................................... 19 包 .................................................................................................................................................... 19 使用運(yùn)行包和設(shè)計(jì)包的比較 ........................................................................................ 19 文件命名標(biāo)準(zhǔn) .................................................................................................................. 19 構(gòu)件 ............................................................................................................................................... 20 用戶自定義構(gòu)件 .............................................................................................................. 20 構(gòu)件單元 ........................................................................................................................... 20 使用注冊(cè)單元 .................................................................................................................. 20 構(gòu)件實(shí)例命名約定 ......................................................................................................... 20 構(gòu)件的前綴 ....................................................................................................................... 20 6 C++代碼編寫標(biāo)準(zhǔn) .................................................................................................................................... 22 7 Java代碼編寫標(biāo)準(zhǔn) .................................................................................................................................. 22 版權(quán)所有 169。 Octant Communications Co. Ltd. 保留所有權(quán)利。 第 6 頁 共 22 頁 軟件部項(xiàng)目管理 項(xiàng)目開發(fā)規(guī)范 :代碼編寫要求 項(xiàng)目開發(fā)規(guī)范 :代碼編寫要求 1 引言 編寫目的 軟件開發(fā)的產(chǎn)品質(zhì)量水平，是一個(gè)由來已久的話題。而提高軟件企業(yè)的產(chǎn)品質(zhì)量水平，必須改進(jìn)軟件產(chǎn)品的開發(fā)過程。為此，制定了本規(guī)范用于指導(dǎo)軟件部的項(xiàng)目開發(fā)過程，從而提高達(dá)到提高產(chǎn)品質(zhì)量的目的。 本規(guī)范以 Rational Unified Process（簡稱 RUP） 軟件工程過程為藍(lán)本，結(jié)合部門的實(shí)際情況而選擇修改，從而使之適應(yīng)當(dāng)前應(yīng)用級(jí)系統(tǒng)設(shè)計(jì)開發(fā)的需要。 本文檔主要對(duì)程序開發(fā)人員的代碼編寫要求做了詳細(xì)的規(guī)定，以使得整個(gè) 開發(fā)小組所編寫的代碼保持一致的風(fēng)格。 本文檔提供給軟件部全體成員參考。 背景 軟件部在基本完成了成都智能交通信息中心系統(tǒng)之后發(fā)現(xiàn)，我們需要一套軟件開發(fā)規(guī)范來指導(dǎo)項(xiàng)目組的開發(fā)過程，使得項(xiàng)目開發(fā)過程具有可重復(fù)性，為此啟動(dòng)了該項(xiàng)目――軟件部項(xiàng)目管理。 項(xiàng)目的名稱： 軟件部項(xiàng)目管理（ Software department Project Management，簡稱 SPM） 任務(wù)提出者： 傲騰通信科技（上海）有限公司軟件部 任務(wù)開發(fā)者： 傲騰通信科技（上海）有限公司軟件部 產(chǎn)品使用地： 上海 產(chǎn)品使用者： 傲騰通信科技（上海）有限公司軟件部 定義 術(shù)語 縮略表示 英文全稱 解釋說明 軟件部項(xiàng)目管理 SPM Octant Software department Project Management 傲騰通信科技（上海）有限公司軟件部為了規(guī)范項(xiàng)目開發(fā)流程而啟動(dòng)的一個(gè)項(xiàng)目 項(xiàng)目開發(fā)規(guī)范 PDS Project Development Specifications 傲騰通信科技（上海）有限公司軟件部定義的一種文檔類別 參考資料 文檔編號(hào) 文檔名稱 作者 版本 來源（存放地） Delphi 4 Code Chinese Borland Inc. C++編程指南 Rational Inc. 2020 Java 編程指南 Rational Inc. 2020 2 安裝盤的創(chuàng)建 軟件部開發(fā)完成的所有系統(tǒng)都使用 Installshield Express 。為了保證快捷方式創(chuàng)建的一致性，現(xiàn)做如下規(guī)定，要求快捷方式都創(chuàng)建在： [Start]\[Programs]\Octant Communications\項(xiàng)目名稱 版權(quán)所有 169。 Octant Communications Co. Ltd. 保留所有權(quán)利。 第 7 頁 共 22 頁 軟件部項(xiàng)目管理 項(xiàng)目開發(fā)規(guī)范 :代碼編寫要求 3 注冊(cè)表的使用 為了統(tǒng)一注冊(cè) 表的使用方式，現(xiàn)做如下規(guī)定，要求注冊(cè)表信息都存放在： HKEY_LOCAL_MACHINE\SOFTWARE\Octant Communications\ProjectName\ModuleName 4 簡單加密算法 對(duì)于保密性要求不是很高的場(chǎng)合下，我們可以采用簡單加密算法 逐位異或算法，具體算法如下： 第一個(gè)字符同自己異或作為密文的第一個(gè)字節(jié)，第二個(gè)字符同密文的第一個(gè)字節(jié)異或作為密文的第二個(gè)字節(jié)，第三個(gè)字符統(tǒng)密文的第二個(gè)字節(jié)異或作為密文的第三個(gè)字節(jié)，依次類推 ……；解密算法和加密算法完全一致。 例子 ： 原始字串： CDITS（ 43 44 49 54 53） 加密過程： 43 XOR 43=43 44 XOR 43=07 49 XOR 07=4E 54 XOR 4E=1A 53 XOR 1A=49 密文： 43 07 4E 1A 49 5 Delphi 代碼編寫標(biāo)準(zhǔn) 通用源代碼格式規(guī)則 縮格 縮格是指在每一級(jí)有兩個(gè)空格。不要在源代碼中保留 tab 字符，這是因?yàn)?tab 字符會(huì)隨著不同用戶的不同設(shè)置和不同的資源管理工具（打印、文檔、版本控制等）而代表不同的寬度。你可以通過關(guān)閉 Environment選項(xiàng)對(duì)話框中 Editor頁上的“ Use tab character”和“ Optimal fill”檢查框（通過 Tools|Environment）來禁止保存 tab字符。 頁邊空格 頁邊空格會(huì)被設(shè)置成 80 字符寬。通常，源碼不會(huì)超出這個(gè)邊界，但這個(gè)方針會(huì)有一些彈性。不管是否有可能，那些超出到另一行的語句會(huì)在一個(gè)逗號(hào)或其他操作符之后與前面的語句相連。當(dāng)一個(gè)語句被打斷相連時(shí)，它應(yīng)比原來的那一行語句縮進(jìn)兩個(gè)字符。 Begin… End 配對(duì) Begin 子句應(yīng)寫在獨(dú)立的一行。例如，下面第一行是錯(cuò)誤的寫法而 第二行是正確的。 for I := 0 to 10 do begin //錯(cuò)誤， begin同 for在同一行 for I := 0 to 10 do //正確， begin出現(xiàn)在獨(dú)立的一行 begin 這個(gè)規(guī)則的例外是當(dāng) begin子句的出現(xiàn)是作為一個(gè) else子句的一部分－參考例子： if some statement then 版權(quán)所有 169。 Octant Communications Co. Ltd. 保留所有權(quán)利。 第 8 頁 共 22 頁 軟件部項(xiàng)目管理 項(xiàng)目開發(fā)規(guī)范 :代碼編寫要求 begin … end else begin someOtherStatement。 end。 end 語句永遠(yuǎn)出現(xiàn)在獨(dú)立的一行。 當(dāng) begin語句不是一個(gè) else子句的一部分時(shí)，相應(yīng) 的 end語句永遠(yuǎn)縮進(jìn)到與 begin部分相對(duì)應(yīng)的位置。 注釋規(guī)范 文件注釋 {********************************************************} { 版權(quán)所有 (C) 2020,2020 傲騰通訊 } {********************************************************} {******************************************************** 項(xiàng)目 ： 模塊 ： 描述 ： 版本 ： 日期 ： 作者 ： 更新 ： ********************************************************} 函數(shù)注釋 {******************************************************** 功能說明： 輸入?yún)?shù)： 輸出參數(shù)： 返回值： 日期 ： 作者 ： 更新 ： *******************************************************