對於一個成功的軟件項目來說,大到解決方案小到一個屬性的命名,不管是對軟件的開發,還是對於后期的維護來說都是非常重要的。經過多年的摸索,我發現自己有一點命名恐懼症。為了方便以后的工作的順利進行,特別對項目開發中的命名進行了一次總結,盡管有些地方不是很完整或者不周,但以后還會進行不斷的補充與完善!
1. 解決方案命名:
對於解決方案來說,它的命名一般相對比較固定,多是系統英文全名的簡寫,如:SPMS,RMG,FinCap等;
2. 項目命名:
項目的命名要體現項目的功能,一般分為2/3/4幾個部分,且常常使用“.”作為分隔符。
A. 通常以解決方案名稱做為第一部分;第二部分及第三部分部分主要說明為Business.Compontnts層,Data.Components層,Validation層或是UI層;第三或第四部分主要用於說明所適用的模塊,如:UserManagement,SystemSetup等
如:SPMS.Business.Components.SystemSetup,SPMS.Integration.Logging及SPMS.Reports.DxReport;
B. 有些時候,對於有些比較孤立的項目,我可可以使用該項目所使用的技術來命名,如:SPMSDPE;
3. 存儲過程的命名:
存儲過程的命名要緊密結合當前Database的Schema,模塊名稱及功能名稱,如:[dbo].[P_SCHEDULED_REQUEST_BY_INPUT_REQUEST].sql;
4. 報表文件的命名:
報表文件的命名要緊密結合當前Database的Schema,模塊名稱及功能名稱,尤其在使用子報表的情況下,還需在名稱的末尾加上Rpt/SubRpt,如:REG.RPT-Summary_Listing_By_Contract_Code_Rpt.rdl,或REG.RPT-Summary_Listing_By_Contract_Code_SubRpt.rdl;
5. 函數的命名:
函數的命名的命名要緊密結合當前Database的Schema,模塊名稱及功能名稱,且最后還會添加“_Function”來加以識別,如:COM.RPT_GetSplitVal_Function.sql;
6. 文件夾的命名:
一般來說文件夾的命名要簡單而易懂,如SPMS.App和SPMS.UI。如果一個文件夾名字太長,則不太容易被快速識別。
以上就是針對自己工作中的工作內容進行的總結,希望自己在命名方面越來越完善,謝謝!