【正文】 列培訓(xùn) 注釋規(guī)則 規(guī)則 文件注釋 在每個(gè) SQL腳本文件的開(kāi)頭，要用塊注釋?zhuān)M(jìn)行文件功能說(shuō)明，文件編寫(xiě)人、聯(lián)系方式和文件創(chuàng)建時(shí)間說(shuō)明等。 由于 PL/SQL語(yǔ)句的特殊性，每行注釋前以 ’’為標(biāo)志。 示例： 收入保障系統(tǒng) 后臺(tái)數(shù)據(jù)庫(kù)腳本 特殊號(hào)碼匯總計(jì)算程序 文本責(zé)任人： xxxx( ) 開(kāi)始創(chuàng)建 6Feb22 神州數(shù)碼思特奇公司基礎(chǔ)工程師系列培訓(xùn) 注釋規(guī)則 規(guī)則 過(guò)程與函數(shù)的注釋 在每個(gè)過(guò)程或函數(shù)的開(kāi)頭，使用塊注釋?zhuān)M(jìn)行函數(shù)功能說(shuō)明，入口出口參數(shù)和返回值說(shuō)明。 示例： 得到集團(tuán)用戶(hù)外部編碼。 @author xxxx @version %I%, %G% @since @inparam regionCode 地市代碼 @inparam smCode 業(yè)務(wù)代碼 @outparam grpUserNo 集團(tuán)用戶(hù)編碼 @return 返回 0表示正確，否則出錯(cuò)！ 6Feb22 神州數(shù)碼思特奇公司基礎(chǔ)工程師系列培訓(xùn) 注釋規(guī)則 規(guī)則 變量注釋 對(duì) SQL代碼中的局部變量，重要的，要進(jìn)行注釋。尤其對(duì) Package和 OBJECT中的內(nèi)部全局變量，特別要進(jìn)行注解。 關(guān)于變量的注釋?zhuān)捎眯形沧⑨尅? 示例： TYPE RefCursor IS REF CURSOR。 定義參考游標(biāo)類(lèi)型 最大欠費(fèi)用戶(hù)指標(biāo)所在地區(qū)描述 f_AreaName VarChar(20)。 對(duì)常量及變量注釋時(shí)，應(yīng)注釋被保存值的含義，包括合法取值的范圍。 6Feb22 神州數(shù)碼思特奇公司基礎(chǔ)工程師系列培訓(xùn) 注釋規(guī)則 規(guī)則 參數(shù)注釋 對(duì)函數(shù)或過(guò)程的每個(gè)參數(shù)進(jìn)行說(shuō)明。 如果取值范圍確定，也一并說(shuō)明。 取值有特定含義的變量（如 boolean類(lèi)型變量），給出每個(gè)值的含義。 規(guī)則 功能性注釋 對(duì)較為復(fù)雜的 SQL 語(yǔ)句應(yīng)注釋?zhuān)⒄f(shuō)明算法和功能。 應(yīng)對(duì)不易理解的分支條件表達(dá)式加注釋。 對(duì)重要的計(jì)算應(yīng)說(shuō)明其功能。 過(guò)長(zhǎng)的函數(shù)實(shí)現(xiàn)，應(yīng)將其語(yǔ)句按實(shí)現(xiàn)的功能分段加以概括性說(shuō)明。 規(guī)則 單行注釋 SQL程序中，盡量采用單行注釋?zhuān)?’’。這樣，有利于程序調(diào)試時(shí)，通過(guò)塊注釋方式，實(shí)現(xiàn)大段代碼注釋。 6Feb22 神州數(shù)碼思特奇公司基礎(chǔ)工程師系列培訓(xùn) 提綱 概述 排版規(guī)則 注釋規(guī)則 命名規(guī)范 SQL程序編碼規(guī)則 SQL性能規(guī)則與建議 程序質(zhì)量保證 安全保障 4 數(shù)據(jù)庫(kù)對(duì)象 PL/SQL程序塊內(nèi)變量 ESQL源文件 6Feb22 神州數(shù)碼思特奇公司基礎(chǔ)工程師系列培訓(xùn) 數(shù)據(jù)庫(kù)對(duì)象 建議 命名長(zhǎng)度和結(jié)構(gòu) 對(duì)象名不超過(guò) 30個(gè)字符，不低于 6個(gè)字符，建議在 8－ 25個(gè)左右。 由 3－ 5部分構(gòu)成，每部分為有一定含義的英文縮寫(xiě)或者數(shù)字。每部分建議為 3－ 4個(gè)字符。 英文縮寫(xiě)參見(jiàn)?常見(jiàn)縮寫(xiě)字典?。 規(guī)則 不得出現(xiàn)省市、項(xiàng)目簡(jiǎn)稱(chēng) 不允許出現(xiàn)某省某地市或某項(xiàng)目的簡(jiǎn)稱(chēng)，例如 sc_CustInfo中的 sc是不許可的。 規(guī)則 年月日等數(shù)字 年月日數(shù)字符號(hào)，一般應(yīng)在數(shù)據(jù)表的尾部。不允許將年月日及其它數(shù)字放在對(duì)象名的中間。 例如， Cust202203Info不許可， CustInfo202203則許可。 6Feb22 神州數(shù)碼思特奇公司基礎(chǔ)工程師系列培訓(xùn) 數(shù)據(jù)庫(kù)對(duì)象 規(guī)則 區(qū)分非正式表 存在于生產(chǎn)環(huán)境的非正式表，如備份表，必須以原表名加前綴‘ bakyymmdd_’，以便于識(shí)別和及時(shí)清理。 因此，正式生產(chǎn)表中，最好不要出現(xiàn) BAK、 BACK之類(lèi)的字符串。 6Feb22 神州數(shù)碼思特奇公司基礎(chǔ)工程師系列培訓(xùn) 數(shù)據(jù)庫(kù)對(duì)象 規(guī)則 命名特例 編號(hào) 數(shù)據(jù)庫(kù)對(duì)象 格式范例 備注 1 全局臨時(shí)表 (golbal temporary table) gTmp_XxxYyyZzz 全局臨時(shí)表屬于 ORACLE的一種特殊的表類(lèi)型，不是指‘臨時(shí)’創(chuàng)建的非正式表 2 視圖 View_XxxYyyZzz 3 普通索引 Idx_TabName_ColumnName ColumnName是該索引第一個(gè)字段的簡(jiǎn)寫(xiě) 4 主鍵索引 Idx_TabName_Pk 5 同義詞 必須與原對(duì)象名一致 若已存在相同的對(duì)象名，必須合理調(diào)整該沖突對(duì)象名或者放棄使用同義詞 6 觸發(fā)器 Trg_XxxYyyZzz 7 存儲(chǔ)過(guò)程 Prc_XxxYyyZzz 8 程序包 Pkg_ XxxYyyZzz 9 函數(shù) Func_XxxYyyZzz 10 序列 Seq_XxxYyyZzz 11 數(shù)據(jù)鏈路 Link_UserName_DbName DBNAME是指遠(yuǎn)程數(shù)據(jù)庫(kù)的名稱(chēng)， USERNAME是指該遠(yuǎn)程庫(kù)的用戶(hù)名 12 分區(qū)表中的分區(qū)名 Part_Xxx 6Feb22 神州數(shù)碼思特奇公司基礎(chǔ)工程師系列培訓(xùn) 提綱 概述 排版規(guī)則 注釋規(guī)則 命名規(guī)范 SQL程序編碼規(guī)則 SQL性能規(guī)則與建議 程序質(zhì)量保證 安全保障 4 數(shù)據(jù)庫(kù)對(duì)象 PL/SQL程序塊內(nèi)變量 ESQL源文件 6Feb22 神州數(shù)碼思特奇公司基礎(chǔ)工程師系列培訓(xùn) PL/SQL程序塊內(nèi)變量 規(guī)則 程序塊內(nèi)變量命名 全局變量，以 g_開(kāi)頭進(jìn)行命名； 包內(nèi)公用變量，以 f_開(kāi)頭命名； 過(guò)程局部變量，以 v_開(kāi)頭命名； 參數(shù)變量，以 p_開(kāi)頭命名； 游標(biāo)變量，以 cur_開(kāi)頭命名。 6Feb22 神州數(shù)碼思特奇公司基礎(chǔ)工程師系列培訓(xùn) 提綱 概述 排版規(guī)則 注釋規(guī)則 命名規(guī)范 SQL程序編碼規(guī)則 SQL性能規(guī)則與建議 程序質(zhì)量保證 安全保障 4 數(shù)據(jù)庫(kù)對(duì)象 PL/SQL程序塊內(nèi)變量 ESQL源文件 6Feb22 神州數(shù)碼思特奇公司基礎(chǔ)工程師系列培訓(xùn) ESQL源文件 規(guī)則 ： ESQL源文件命名 源文件命名規(guī)則，一般如下： 或者 我們以前的 ESQL命令一般都用 *.cp，而國(guó)際標(biāo)準(zhǔn)一般都用 *.pc。 特此約定，以前的程序目錄沿用 *.cp，新的程序目錄使用 *.pc命名。 文件名以大寫(xiě)字母 R開(kāi)頭，后面跟操作代碼。操作代碼的前兩位放在最前面，后面的兩位按照順序放在? _?的后面，如 R11_04060820。 6Feb22 神州數(shù)碼思特奇公司基礎(chǔ)工程師系列培訓(xùn) 提綱 概述 排版規(guī)則 注釋規(guī)則 命名規(guī)范 SQL程序編碼規(guī)則 SQL性能規(guī)則與建議 程序質(zhì)量保證 安全保障 4 數(shù)據(jù)庫(kù)對(duì)象 PL/SQL程序塊內(nèi)變量 ESQL源文件 6Feb22 神州數(shù)碼思特奇公司基礎(chǔ)工程師系列培訓(xùn) 常用英文縮寫(xiě)字典 規(guī)則 ：業(yè)務(wù)操作類(lèi)（一） 中文名稱(chēng) 英文名稱(chēng) 英文縮寫(xiě) 讀取 get get 設(shè)置 set set 查詢(xún) query qry 變更 change chg 提交、確認(rèn) confirm cfm 沖正、回滾 rollback roll 驗(yàn)證 validate vali 比較 pare cmp