SQL命名編碼規(guī)范

《SQL命名編碼規(guī)范》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在教育資源-天天文庫。

1、1．引言12．命名規(guī)范12.1基本命名規(guī)則12.2定制對(duì)象命名規(guī)則22.3變量命名規(guī)則23．程序書寫規(guī)范43.1大小寫風(fēng)格：43.2注釋風(fēng)格：43.3縮進(jìn)規(guī)則：63.4其他73.5例子74．SQL優(yōu)化規(guī)則94.1索引的使用原則94.2其他111．引言本規(guī)范用于說明在利用PL/SQL開發(fā)Oracle數(shù)據(jù)庫后臺(tái)應(yīng)用程序時(shí)，應(yīng)遵守的某些原則。本規(guī)范的制定主要出于以下幾方面的考慮：ü效率ü可讀性ü可維護(hù)性ü規(guī)范性規(guī)范中未做聲明的內(nèi)容，以滿足開發(fā)總則為準(zhǔn)。2．命名規(guī)范2.1基本命名規(guī)則本規(guī)范中采用的命名規(guī)則，基本模式為：前綴_描述其中前綴根據(jù)定制對(duì)象，變量類型的不同而變化。描述的命名規(guī)

2、則為：信息結(jié)構(gòu)通則命名規(guī)則與字母標(biāo)識(shí)符命名兩者相結(jié)合（1）與表中字段相對(duì)應(yīng)的變量命名采取代碼方式，以與字段命名相對(duì)應(yīng)（2）其余用有意義的字母標(biāo)識(shí)符（如：拼音——各個(gè)字漢語拼音首字母聯(lián)結(jié)成的字符串，對(duì)只有兩個(gè)字符的，采用名稱全拼）2.2定制對(duì)象命名規(guī)則如表2-1所示前綴定制對(duì)象舉例說明pkg程序包個(gè)人帳戶pkg_grzhprc過程生成個(gè)人帳戶prc_scgrzhfun函數(shù)確定繳費(fèi)比例fun_qdjfblind索引ind_grzhtri觸發(fā)器tri_grcbzlvi視圖vi_seq序列發(fā)生器seq_pk主鍵fk外鍵syn同義詞dlkDBLINKsnp快照表2-1定制對(duì)象命名規(guī)則2

3、.3變量命名規(guī)則變量命名規(guī)則中前綴由兩部分組成：變量類型前綴+數(shù)據(jù)類型前綴變量類型前綴規(guī)則如下表2-2：前綴變量類型g全局變量def常量表2-2變量類型命名規(guī)則數(shù)據(jù)類型前綴命名規(guī)則如下表2-3：前綴數(shù)據(jù)類型binBinary_IntegerbBooleancChardDatelLonglobLOBnNumberdecDecimaldblDoubleiIntegerfFloatrRealplsPls_IntegerRec%ROWTYPErawRAWrowROWIDstrVarchar2curCURSORrecRecordtabTablerefcurREFCURSORu用戶自定義

4、數(shù)據(jù)類型typTYPE自定義類型類型e異常（EXCEPTION）表2-3數(shù)據(jù)類型前綴命名規(guī)則例：聲明一全局類數(shù)值型：gn_grsxh聲明一局部類：str_name說明：對(duì)于未在上述數(shù)據(jù)類型中列出的其它數(shù)據(jù)類型（包括系統(tǒng)提供的數(shù)據(jù)類型），其數(shù)據(jù)類型前綴的命名必須不與表3-4中的前綴重名，它們的前綴命名規(guī)則是未規(guī)定的。3．程序書寫規(guī)范3.1大小寫風(fēng)格：類型約定舉例保留字大寫B(tài)EGIN、DECLARE、ELSIF內(nèi)置函數(shù)大寫SUBSTR、COUNT、TO_NUMBER預(yù)定義類型大寫NUMBER(7,2)、BOOLEANSQL關(guān)鍵字大寫SELECT、INTO、WHERE數(shù)據(jù)庫對(duì)象小寫

5、abc007、ac021變量名小寫gn_dwhrbl表3-1大小寫書寫規(guī)范3.2注釋風(fēng)格：注釋總是加在程序的需要一個(gè)概括性說明或不易理解或易理解錯(cuò)的地方。注釋應(yīng)語言簡(jiǎn)煉、易懂而又準(zhǔn)確。3.2.1源代碼文件的注釋（1）在文件的頭部必須標(biāo)明程序名稱，它所完成的主要功能。（2）文件的作者，及完成時(shí)間。（3）文件的狀態(tài)：測(cè)試/未測(cè)試。（4）主要修改活動(dòng)的修改人、時(shí)間、簡(jiǎn)單原因說明列表、版本號(hào)。（5）維護(hù)過程中需要修改程序時(shí)，應(yīng)在被修改語句前面注明修改時(shí)間和原因說明。例：REM文件名：REM功能描述：REM狀態(tài)：REM作者：REM完成時(shí)間：REM修改：時(shí)間版本號(hào)修改人修改原因3.2.2

6、包、過程、函數(shù)的注釋(1)頭部必須進(jìn)行功能和參數(shù)說明；(2)主體部分，如算法復(fù)雜時(shí)，應(yīng)以注釋的方式對(duì)其算法結(jié)構(gòu)作出說明；3.2.3語句的注釋注釋單獨(dú)成行、放在語句前面。(1)應(yīng)對(duì)不易理解的分支條件表達(dá)式加注釋；(2)不易理解的循環(huán)，應(yīng)說明出口條件(有GOTO的程序還應(yīng)說明入口條件)；(1)對(duì)重要的計(jì)算應(yīng)說明其功能；(2)過長(zhǎng)的函數(shù)實(shí)現(xiàn)，應(yīng)將其語句按實(shí)現(xiàn)的功能分段加以概括性說明；(3)供別的文件或函數(shù)調(diào)用的函數(shù)，絕不應(yīng)使用全局變量交換數(shù)據(jù)；(4)每條SQL語句均應(yīng)有注釋說明（表名、字段名）。例：SELECTabc007,abc008,abc009,--上年計(jì)入金額，本年計(jì)入金額

7、，本年繳費(fèi)月數(shù)abc010,abc011,--年度、本年繳費(fèi)基數(shù)、abc012,abc013--本年帳戶支付累計(jì)金額、本年統(tǒng)籌支付金額INTOln_abc007,ln_abc008,ln_abc009,ln_abc010,ln_abc011,ln_abc012,ln_abc013FROMab003--個(gè)人帳戶WHEREabc001=ivc_shbzh--ANDabd004=...;--UPDATEab003--SETabc004=ln_abc004,--abc005=ln_abc005,--...WHE