前言
此规范分为四部分:文档规范、结构规范、注释规范、命名规范。
文档规范
每个开发项目必须含有以下两个文档:需求文档、数据库说明文档。
需求文档
由产品经理提供,该文档应需求清晰明了,多以图文结合的方式描述需求。项目开发完成
之后,将由开发者对该文档进行打分,用于体现该文档中包含的内容与实际开发过程中的
功能的差异程度。
数据库说明文档
一份描述数据库各类信息的文档,如数据库表结构信息、存储过程和函数信息、视图信息
任务信息等。
其中,不建议以中文拼音首字母的方式来进行命名。但出于对“原有项目”不适合调整的考
虑,若数据库中含“以中文拼音首字母”命名的方式,则需要额外提供一份“命名说明对照表”。
项目结构规范
解决方案和项目的命名规范
解决方案名称应当能够完整表述系统的总体功能,如咨询企业信用档案管理系统,其解决
方案名称可以为“ConsulngCompanyCreditFilesManageSystem”。
有时需要加上软件公司的标识,如“PMSoConsulngCompanyCreditFilesManageSystem”。
这种需要添加软件公司标识的命名方式,也可以用“_”连接软件公司标识和系统名称。
项目名称应当体现项目的总体功能,并加上“解决方案名称简写”作为前缀,再以“.”连接。
如工具类的项目名可以是” PMSo.Ulity”。由于工具类库是公用的,并不挂在某个系统项
评论0