您的当前位置:首页正文

软件开发中的命名规则

2023-01-01 来源:钮旅网
软件开发中的命名规则

对于⼀个成功的软件项⽬来说,⼤到解决⽅案⼩到⼀个属性的命名,不管是对软件的开发,还是对于后期的维护来说都是⾮常重要的。经过多年的摸索,我发现⾃⼰有⼀点命名恐惧症。为了⽅便以后的⼯作的顺利进⾏,特别对项⽬开发中的命名进⾏了⼀次总结,尽管有些地⽅不是很完整或者不周,但以后还会进⾏不断的补充与完善!

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

以上就是针对⾃⼰⼯作中的⼯作内容进⾏的总结,希望⾃⼰在命名⽅⾯越来越完善,谢谢!

因篇幅问题不能全部显示,请点此查看更多更全内容