软件开发中的命名规则

Posted 2020-08-27 Joye Zhou

      对于一个成功的软件项目来说，大到解决方案小到一个属性的命名，不管是对软件的开发，还是对于后期的维护来说都是非常重要的。经过多年的摸索，我发现自己有一点命名恐惧症。为了方便以后的工作的顺利进行，特别对项目开发中的命名进行了一次总结，尽管有些地方不是很完整或者不周，但以后还会进行不断的补充与完善！

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。如果一个文件夹名字太长，则不太容易被快速识别。

 

   以上就是针对自己工作中的工作内容进行的总结，希望自己在命名方面越来越完善，谢谢！