一点简单常用却又易忽视的命名规范
1、项目命名空间规范
A、使用有意义的名字定义命名空间,例如产品名或者公司名
B、命名空间应分层定义
C、所有单词第一个字母要大写,单词的单复数要约定一致
格式:[公司名].[产品名|项目名].[子系统名|模块名].[...]
如:Microsoft.Office.Tools.Word
Microsoft.Office.Tools.Excel
Microsoft.SqlServer.ConnectionInfo
Microsoft.SqlServer.GridControl
Microsoft.VisualStudio.Modeling
Microsoft.VisualBasic.Compatibility.Data
Infragistics.WebUI.UltraWebGrid
Infragistics.WebUI.WebSchedule
第一层为公司名,如:Microsoft
第二层为产品名或项目名,如:Office
第二层根据具体情况还可以继续往下细分,比如可以再根据子系统或功能模块划分一层,如:Microsoft.VisualBasic.Compatibility.Data
第三层要与系统架构一致,如:Client或Web、Entity、Data、Service、Agent、Contract等
2、数据库命名规范
A、数据库名:项目名称或代号+"DB"
B、视图/表命名:易懂的大写英文单词
C、字段名:使用若干个易懂的大写单词
单词的单复数要保持一致(如统一采用单数);
前缀要保持一致,避免混乱(如表:T_,视图:V_,列字段:C_,也可按系统模块划分),避免和DB保留字重复;
根据数据库的差异,单词统一采用大写或小写(一般可统一为大写),否则有的数据库在写SQL语句时要加前后缀才能识别。
约定所有文字定义使用英文字母,如需使用阿拉伯数字则全用半角。
规范已有很多(编码规范、设计规范...),但仍有设计/开发人员会忽视,仅列两点。
缘何忽略?你是否遇到这样的情况:项目都开发完毕了,项目的名字全称都不知道甚至还未最终确定!
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。