1.1 目的
　　為了保證企業(yè)編寫出的程序都符合相同的規(guī)范，保證一致性、統(tǒng)一性而建立的數(shù)據(jù)庫(kù)命名規(guī)范。
　　編碼規(guī)范對(duì)于程序員而言尤為重要，有以下幾個(gè)原因：
　　1. 一個(gè)項(xiàng)目的生命周期中，80%的花費(fèi)在于維護(hù)；
　　2. 幾乎沒有任何一個(gè)項(xiàng)目，在其整個(gè)生命周期中，均由最初的開發(fā)人員來維護(hù)；
　　3. 命名規(guī)范可以改善項(xiàng)目的可讀性，可以讓程序員盡快而徹底地理解新的代碼；
　　4. 如果你將源碼作為產(chǎn)品發(fā)布，就需要確任它是否被很好的打包并且清晰無(wú)誤，比如你已構(gòu)建的其它任何產(chǎn)品。
　　為了執(zhí)行規(guī)范，每個(gè)軟件開發(fā)人員必須一致遵守編碼規(guī)范。
　　1.2 范圍
　　適合于本項(xiàng)目中編寫的命名規(guī)則。
　　1.3 命名原則
　　1. 使名稱足夠長(zhǎng)以便有一定的意義，并且足夠短以避免冗長(zhǎng)；
　　2. 唯一名稱在編程上僅用于將各項(xiàng)區(qū)分開；
　　3. 表現(xiàn)力強(qiáng)的名稱是為了幫助人們閱讀。
　　因此，提供人們可以理解的名稱是有意義的。不過，請(qǐng)確保選擇的名稱符合適用語(yǔ)言的規(guī)則和標(biāo)準(zhǔn)。
　　1.4 SQL命名規(guī)范
　　·1.4.1 表(Table)命名規(guī)范
　　1． 使用表關(guān)鍵字符+完整的功能英文名稱；
　　2． 不建議使用“_”來連接兩個(gè)自然名稱。
　　3． 在多個(gè)功能英文名稱組合時(shí)首寫字母應(yīng)為大寫;
　　例：
　　建議：
　　UserInfo??????? 基礎(chǔ)信息模塊中的用戶信息
　　Shopping???? 購(gòu)物信息表單
　　不建議：
　　tbUserInfo或TB_Userinfo或TBUserInfo
　　·1.4.2 字段(Column)命名規(guī)范
　　1． 使用 Pascal 大小寫來命名字段；
　　2． 對(duì)于公認(rèn)的縮寫使用全大寫來命名；
　　3． 不建議使用“_”來連接兩個(gè)自然名稱。
　　例：
　　建議：
　　UserID????????? 用戶ID
　　UserName??????? 用戶名稱
　　不建議：
　　UserId或Userid
　　User_Name
　　·1.4.3 存儲(chǔ)過程(Procedure)命名規(guī)范
　　1. 使用表關(guān)鍵字符sp+完整的功能英文名稱+By+操作關(guān)鍵字；
　　2. 關(guān)鍵字符sp與功能名稱通過“_”來連接；
　　3. 對(duì)于存儲(chǔ)過程的參數(shù)，建議與表中字段名一致。
　　4. 查詢關(guān)鍵字為sel，插入關(guān)鍵字為ins，修改關(guān)鍵字為up，刪除關(guān)鍵字為del；
　　例：
　　sp_selUserInfoByID?? 通過ID查詢單條用戶信息
　　sp_upUserInfoByName???? 通過用戶姓名修改用戶詳細(xì)信息
　　sp_insUserInfo????? 插入單個(gè)用戶信息
　　·1.4.4 觸發(fā)器(Trigger)命名規(guī)范
　　1. 使用表關(guān)鍵字符tr+完整的功能英文名稱+By+操作關(guān)鍵字；
　　2. 同存存儲(chǔ)過程要求
　　·1.4.5 視圖(View)命名規(guī)范
　　1. 使用表關(guān)鍵字符vw+完整的功能英文名稱+By+操作關(guān)鍵字；
　　2. 同表要求
　　·1.4.6 函數(shù)(Function)命名規(guī)范
　　1. 使用表關(guān)鍵字符ft+完整的功能英文名稱；
　　2. 同表要求。
　　1.5文件規(guī)范1.5.1文件名命名
　　1．??? 名字應(yīng)該能夠標(biāo)識(shí)事物的特性；
　　2．??? 名字盡量不使用縮寫，除非它是眾所周知的；
　　3．??? 名字可以有兩個(gè)或三個(gè)單詞組成，但通常不應(yīng)多于三個(gè)。在名字中，所有單詞第一個(gè)字母大寫，縮寫都要大寫。不建議使用拼音首字母來組成文件名；
　　4．??? 使用名詞或名詞短語(yǔ)+動(dòng)詞命名文件；例如：UserList.aspx，UserUpdate.aspx
　　5．??? 少用縮寫；
　　6．??? 不要使用下劃線字符 (_)。例如：User_Query.aspx
　　1.5.2文件格式
　　文件應(yīng)該按照以下格式順序來實(shí)現(xiàn)：
　　1.???????? 開頭注釋
　　2.???????? 文件名
　　3.???????? 創(chuàng)建人
　　4.???????? 日期
　　5.???????? 描述
　　6.???????? 版本
　　例子：
　　//******************************************************************//
　　//
　　//** 文件名:?? RandomCreator.cs
　　//
　　//** 創(chuàng)建人:?? 張三
　　//
　　//** 日 期:?? 2007/11/29
　　//
　　//** 描 述:?? 主要完成隨機(jī)數(shù)字的生成
　　//**
　　//
　　//** 版 本:?? 砂子塘社區(qū)網(wǎng) V2.0版
　　//
　　//******************************************************************//
　　using System;
　　using System.Collections.Generic;
　　using System.Text;
　　namespace COMM
　　{
　　class RandomCreator
　　{
　　}
　　}
　　1.5 C#命名規(guī)范1.5.1注釋(Comment)規(guī)范
　　注釋規(guī)范包括：模塊(類)注釋規(guī)范、類的屬性、方法注釋規(guī)范、代碼間注釋。
　　1.5.2類(Class)命名規(guī)范
　　1．??? 使用 Pascal 大小寫；
　　2．??? 用名詞或名詞短語(yǔ)命名類；
　　3．??? 使用全稱避免縮寫，除非縮寫已是一種公認(rèn)的約定，如URL、HTML；
　　4．??? 不要使用類型前綴；
　　5．??? 不要使用下劃線字符 (_)；
　　6．??? 派生類名稱的第二個(gè)部分應(yīng)當(dāng)是基類的名稱；
　　例如：
　　ApplicationException 對(duì)于從名為 Exception 的類派生的類是適當(dāng)?shù)拿Q，原因ApplicationException 是一種Exception。
　　7．??? 請(qǐng)?jiān)趹?yīng)用該規(guī)則時(shí)進(jìn)行合理的判斷。
　　例如：
　　Button 對(duì)于從 Control 派生的類是適當(dāng)?shù)拿Q。盡管按鈕是一種控件，但是將 Control 作為類名稱的一部分將使名稱不必要地加長(zhǎng)。
　　1.5.3接口(Interface)命名規(guī)范
　　接口的命名規(guī)范同類命名，只是通常在名稱前加前綴+“I”。
　　例子：
　　public interface IManager
　　1.5.4參數(shù)(Param)命名規(guī)范
　　1．??? 使用描述性參數(shù)名稱。參數(shù)名稱應(yīng)當(dāng)具有足夠的描述性，以便參數(shù)的名稱及其類型可用于在大多數(shù)情況下確定它的含義；
　　2．??? 對(duì)參數(shù)名稱使用 Camel 大小寫；
　　例子:
　　public ManagerInfo[] GetResultManager(ArrayList alParam,ArrayList alValue)
　　{
　　return dc.DriveManager().GetResultManager(alParam,alValue);
　　}
　　1.5.5方法(Method)命名規(guī)范
　　1．? 使用描述性名稱。名稱應(yīng)當(dāng)具有足夠的描述性，以便名稱可用于在大多數(shù)情況下確定它的含義；
　　2．? 使用動(dòng)詞或動(dòng)詞短語(yǔ)命名方法；
　　3．? 使用 Pascal 大小寫。
　　例子：
　　public void AddUser(User userInfo)
　　1.5.6屬性(Property)命名規(guī)范
　　1.???????? 使用名詞或名詞短語(yǔ)命名屬性；
　　2.???????? 使用 Pascal 大小寫。
　　例子：
　　public Color BorderColor
　　{
　　get {}
　　set {}
　　}
　　來自：龍運(yùn)在線(www.longyun123.com)

總結(jié)

以上是生活随笔為你收集整理的软件开发命名规则的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。