【正文】 unctions 用來描述參數(shù), 包括它的類型和使用方法 @return description Member Functions 返回值說明, 包括類型, 和代表的意義. @since Interfaces, Classes, Member Functions 顯示該項目什么時候開始存在的 例如 @since JDK @see ClassName Classes, Interfaces, Member Functions, Fields 建立一個超級連接到指定的class作為參考 @see ClassNamemember functionName Classes, Interfaces, Member Functions, Fields 建立一個超級連接到指定的某一個方法中去 @version text Classes, Interfaces 版本號 3 Class/Interface文件頭注釋約定 所有類,接口的開始都要有關(guān)于這個類(接口)的注釋 /** * Title: Pushclass * Description: a session bean for push class * Copyright: Copyright (c) 2000 * Company: * @author: raogaohua* @version: */ 方法注釋規(guī)范 所有的Method的開始都應(yīng)該有描述這段代碼的功能的一段簡明注釋. 但是這種描述不應(yīng)該包括具體執(zhí)行過程，因為這常常是隨時間而變的，可能會成為錯誤的注釋. /** * Name: pString * Description: 找出一個String在一個String[]中位置index * Author: zhaoshouiang * @param strArray String數(shù)組 * @param strFind 需要找的String * @return =0 : 找到, 返回strDind在strArray中的index * 1 : 沒找到 */ public int pString(String[] strArray, String strFind) 在方法中的注釋要求做到下列幾點: ，來描述變量的使用. 、控件及Method的命名應(yīng)該足夠清楚, 使得只有復(fù)雜的執(zhí)行細節(jié)才需要嵌入注釋. 、Method、算法、數(shù)據(jù)庫及系統(tǒng)需求. 一段描述算法的偽代碼能會有所幫助。 第三章 數(shù)據(jù)庫編碼規(guī)范數(shù)據(jù)庫的規(guī)范包括一般規(guī)范、注釋規(guī)范、命名規(guī)范、和建模規(guī)范；該部分規(guī)范包含了SqlServer和Oracle數(shù)據(jù)庫設(shè)計時應(yīng)該共同遵守的規(guī)范。 一般規(guī)范 ◇ 所有對象必須給以有意義的名稱，能描述清楚當(dāng)前對象的功能，達到見名知義的效果； ◇ 每一個數(shù)據(jù)庫表都必須給出詳細的功能說明； ◇ 數(shù)據(jù)庫表的每一個字段，都必須給出詳細的注釋，包括意義、是否允許空值、初值、枚舉值及其意義； ◇ 未經(jīng)批準，任何人不得對已定義的庫表結(jié)構(gòu)進行增刪和改變字段意義、以及不按其原義使用； ◇ 數(shù)據(jù)庫表必須設(shè)置主鍵，而且主鍵中不允許包含日期、浮點類型的字段。 ◇ 設(shè)計數(shù)據(jù)庫時，盡量考慮到不同數(shù)據(jù)庫規(guī)范之間的通用性，以方便將來轉(zhuǎn)換數(shù)據(jù)庫，比如在SqlServer數(shù)據(jù)庫設(shè)計時，應(yīng)盡量避免使用對SqlServer非常依賴的特性，比如自增字段、TEXT、LONG、TINYINT等字段； 事務(wù)處理 在SQL腳本中，要進行事務(wù)的定義、提交、回滾，避免對某些數(shù)據(jù)的死鎖，注意事務(wù)的嵌套，應(yīng)該避免，如果確實需要，要使用保存點來處理。另外通常情況下事務(wù)的隔離級應(yīng)該使用READCOMMITTED，不要隨意改動。如果在數(shù)據(jù)處理時出現(xiàn)錯誤，應(yīng)當(dāng)返回錯誤信息，并向用戶進行提示。 功能實現(xiàn)原則 在數(shù)據(jù)庫系統(tǒng)中，數(shù)據(jù)一致性、完整性保證，系統(tǒng)功能、數(shù)據(jù)檢索等實現(xiàn)的途徑有視圖、觸發(fā)器、存儲過程、永久數(shù)據(jù)庫表等。究竟什么條件下采用什么方式實現(xiàn)所需要的功能，下面將針對數(shù)據(jù)庫功能實現(xiàn)方式給出一般規(guī)定和注釋要求。 對象使用原則 包括視圖、存儲過程、索引和觸發(fā)器等對象的使用原則。 視圖使用原則 視圖是虛擬的數(shù)據(jù)庫表，在使用時要遵循以下原則： ?? 從一個或多個庫表中查詢部分數(shù)據(jù)項； ?? 為簡化查詢，將復(fù)雜的檢索或字查詢通過視圖實現(xiàn)； ?? 提高數(shù)據(jù)的安全性，只將需要查看的數(shù)據(jù)信息顯示給權(quán)限有限的人員； ?? 視圖中如果嵌套使用視圖，級數(shù)不得超過3級； ?? 由于視圖中只能固定條件或沒有條件，所以對于數(shù)據(jù)量較大或隨時間的推移逐漸增多的庫表，不宜使用視圖； ?? 除特殊需要，避免類似Select * from [TableName] 而沒有檢索條件的視圖； 存儲過程原則 存儲過程的建立如同其它語言形式的編程過程，適合采用模塊化設(shè)計方法；當(dāng)具體算法改變時，只需要修改需要存儲過程即可，不需要修改其它語言的源程序。當(dāng)和數(shù)據(jù)庫頻繁交換數(shù)據(jù)是通過存儲過程可以提高運行速度。由于只有被授權(quán)的用戶才能執(zhí)行存儲過程，所以存儲過程有利于提高系統(tǒng)的安全性。 存儲過程是宿主于服務(wù)器端的SQL腳本集合，在使用時要遵循以下原則： 存儲過程必須檢索數(shù)據(jù)庫記錄，甚至修改（執(zhí)行Insert、Delete、Update、Drop、Create等操作）數(shù)據(jù)庫信息。如果某項功能不需要和數(shù)據(jù)庫打交道，則不得通過存儲過程的方式實現(xiàn)。 實現(xiàn)數(shù)據(jù)庫級別的某項具體功能，功能的實現(xiàn)是修改數(shù)據(jù)庫信息或?qū)χ付〝?shù)據(jù)庫信息加工后將加工結(jié)果返回給調(diào)用者。 索引使用原則 根據(jù)索引的類型分別列出相應(yīng)的原則。一般性原則是根據(jù)查詢的條件，或經(jīng)常按照什么需要進行查詢，則建立和查詢條件相關(guān)的索引。索引建立的合理可以提高檢索速度，但會增加數(shù)據(jù)庫存儲空間、建立數(shù)據(jù)記錄修改或插入記錄時的時間。 建立族索引的字段必須是查詢或檢索語句的條件字句中用到的字段。 族索引原則 在盡可能少的列（字段）上建立族索引。 可能進行批量數(shù)據(jù)修改的字段，不適宜建立族索引。 包含大量非重復(fù)值的列，在進行單值（返回）查詢的時候，群集索引應(yīng)當(dāng)更有效，所以一般情況下，默認的會在主鍵上建立集群索引，由于sqlserver上一個表只能夠建立一個群集索引，通常建議不需要改動。而對于oracle，機制有些不同，就普通的來說，位映射索 引是非常緊湊的，適合于取值范圍比較小，很少改動，匹配比較標準的列進行索引，當(dāng)使用一個或幾個來一起解決查詢問題時（可以是or查詢，也可以是and查詢），位映射索引實際上起了很大的作用，位映射索引適合于數(shù)據(jù)倉庫應(yīng)用。Btree索引適合于值重復(fù)比較少的列上，更新的成本比較低，適合聯(lián)機事務(wù)處理應(yīng)用。 觸發(fā)器使用原則 作為一種特殊的存儲過程，觸發(fā)器通過數(shù)據(jù)的修改而觸發(fā)執(zhí)行，起作用是為確保數(shù)據(jù)的完整性和一致性不被破壞而創(chuàng)建，實現(xiàn)數(shù)據(jù)的完整約束。觸發(fā)器的另一個作用用來備份關(guān)鍵的數(shù)據(jù)，例如電費、電價的修改，系統(tǒng)自動保存修改前的結(jié)果，實現(xiàn)對修改結(jié)果的稽查為恢復(fù)數(shù)據(jù)提供依據(jù)。避免通過觸發(fā)器實現(xiàn)某些特定功能。開發(fā)人員可以提出建立觸發(fā)器的要求而不得自行建立，觸發(fā)器的建立必須由公司統(tǒng)一規(guī)劃建立、修改和發(fā)布。 觸發(fā)器不允許創(chuàng)建數(shù)據(jù)庫對象。 觸發(fā)器中一般不使用SELECT語句返回信息。 對Oracle中具有以下結(jié)構(gòu)的視圖： ：類似AVG和COUNT的集合函數(shù)； ：GROUP BY字句； ：DISTINCT關(guān)鍵字； ：包含多種類型的連接； 建立觸發(fā)器時，必須使用INSTEADOF觸發(fā)器，INSTEADOF觸發(fā)器提供的代碼可以由Oracle用戶編寫的任何DML語句中得到執(zhí)行。 注釋內(nèi)容： 觸發(fā)器的注釋，必須準確描述觸發(fā)器的目的、涉及的相關(guān)數(shù)據(jù)庫表，變量定義、實現(xiàn)方法。此外對觸發(fā)器的創(chuàng)建時間、創(chuàng)建人員等信息描述清楚。 腳本注釋規(guī)范 對于數(shù)據(jù)庫腳本程序塊，例如存儲過程、自定義函數(shù)等，需要有標準的注釋，以便所有軟件人員都能一目了然的看懂當(dāng)前程序塊的作用及流程。 存儲過程 /**************************************************************** 過程名稱： 調(diào)用方式： 參數(shù)說明： 返回結(jié)果： 過程功能： 操作說明： 設(shè)計時間： 代碼設(shè)計者： ============================================================================== 實現(xiàn)方法： 修改記錄 修改人 修改時間 修改原因 ============================================================================== 備注：***********************************************************************/ 說明：操作說明中必須給出當(dāng)前存儲過程檢索到的數(shù)據(jù)庫表（或視圖）、修改（刪除、增加）記錄的庫表、執(zhí)行的其它存儲過程。 觸發(fā)器 /*********************************************************************** 觸發(fā)器名稱： 觸發(fā)器功能： 操作說明： 設(shè)計時間： 代碼設(shè)計者： ************************************************************************ 實現(xiàn)方法： 修改記錄 修改人 修改時間 修改原因 ======================================================================== 備注： ***********************************************************************/ 視圖 /*********************************************************************** 視圖名稱： 目 的： 設(shè)計時間： 視圖設(shè)計者： （表、） ************************************************************************ 實現(xiàn)方法： ======================================================================= 修改記錄 修改人 修改時間 修改原因 ======================================================================= 備注： ***********************************************************************/ 其它 ◇ 修改處的注釋遵照代碼規(guī)范的修改處注釋，； ◇ 在每一個變量的行后部或上一行，說明變量的用途； ◇ 程序中盡可能隨時注釋當(dāng)前行或當(dāng)前代碼塊的作用。 命名規(guī)范 原則： ◇ 對數(shù)據(jù)庫所有對象的命名，要本著清晰、簡短的原則，名稱反映功能，力求見名知義；如果名稱太長，可以使用部分重點單詞相連，能接近本意即可。 ◇ 所有字母全部小寫，合理使用下劃線進行分割。 表命名 使用描述性的單詞或其縮寫，所有字母全部小寫，多個單詞之間以下劃線連接，達到見名知義的效果。 如student_grade：學(xué)生成績表 字段命名 使用功能描述性的單詞或其縮寫，所有字母全部小寫，多個單詞之間以下劃線連接，達到見名知義的效果。例如class_name 視圖命名 視圖名稱由三部分組成： 前綴（v）+下劃線+描述性名稱 例如：v_student_class 存儲過程命名 存儲過程名稱由四部分組成： 前綴（sp）+下劃線+描述性名稱 例如： 索引命名 索引過程名稱由五部分組成： 前綴（i）+是否唯一（u、d）+是否聚簇（c、n）+下劃線+索引名稱 例如iuc_name創(chuàng)建的唯一且是聚簇型的索引；idn_usename創(chuàng)建的非唯一且不是聚簇型的索引。 觸發(fā)器命名 觸發(fā)器名稱由四部分組成： 前綴（t）+觸發(fā)器類型（i、u、d）+下劃線+庫表名稱 例如ti_student_base在庫表上創(chuàng)建的插入觸發(fā)器；tu_student_detail在庫表上創(chuàng)建的修改觸發(fā)器。 腳本書寫規(guī)范 ◇ 腳本中所有的字