前一篇文章中对于团队做了讲解,(文章参照)
针对Coding 的培训中,关于开发规范部分的PPT内容,
开发规范的作用
1)开发规范作用于团队开发内部,保证不同的开发人员在工作环境设定,代码开发规范以及日常开发的行为能够达到共通的要求。
2)开发规范用于开发的各个阶段,保证开发中的各个问题能够按照开发制定的标准进行处理(比如:代码管理,版本冲突,代码命名规范等等)。
3)开发规范作为最终开发产品代码的检测标准,通过对最终产品代码的再次检测,来保证代码的规范性,可维护性。
开发规范作为开发中的检测标准,来约束开发人员的开发行为,达到在团队内部提高开发质量和减少开发成本的作用。
开发规范的要求
1)制定开发时要求对于要求的内容必须语义清晰,确保所制定的内容不会有歧义发生。
2)对于开发中说明性的内容,以图片说明为主,减少文字性的描述。
3)对于开发规范避免在项目开发后发生对代码命名,代码逻辑分层等部分内容的变更。
4)如果开发规范发生变更,确保项目团队内部所有的人员都按照最新的开发标准进行开发。
5)对于开发规范也要求进行版本管理。
开发规范的内容
作为一份比较理想的开发规范,必须具备有以下的开发内容:
1)开发平台的约定
a)开发操作系统环境和最总用户使用环境(包含ServicePack版本号)
b)开发工具版本
c)数据库类型已经版本
d)网络状态
e)版本控制工具
f)开发使用硬件环境和组成
g)开发规范的执行问题
2)工作方式的约定
a)开始工作前的行为(每天开始工作先update代码)
b)工作结束后的行为(每天结束后需要commit全部代码)
c)版本控制行为(代码commit的要求和发生冲突的解决办法)
d)文件保存要求(新增代码文件和备份文件的处理)
3)代码书写约定
a)代码的命名规则
b)代码的注释要求
c)代码的修改履历要求
d)代码的文件保存要求(一个类保存在一个文件中等)
e)代码的外观要求(代码的对齐,换行要求)
f)数据库代码的书写要求
4)程序的结构约定
a)通用代码的处理方式
b)接口的处理方式
c)代码的内部的逻辑划分要求
d)程序的分层结构要求
e)程序的异常处理要求
5)辅助工具的使用约定
a)版本控制工具使用说明
b)代码生成工具的使用说明
c)单元测试工具的使用说明
d)Bug管理工具的使用说明
6)其他约定
a)单元测试方法约定
b)版本控制约定
c)计划管理约定
d)测试数据的约定
开发规范的执行问题
1)制定问题
a)鼓励全部的项目开发人员都参与规范的制定
b)制定标准是需要考虑代码的维护性和实际开发的便利性
2)执行问题
a)依照开发规范对于代码进行检测,对于存在问题要求修正。
b)通过团队内部人员交叉检测的方式来执行开发标准
针对Coding 的培训中,关于开发规范部分的PPT内容,
开发规范的作用
1)开发规范作用于团队开发内部,保证不同的开发人员在工作环境设定,代码开发规范以及日常开发的行为能够达到共通的要求。
2)开发规范用于开发的各个阶段,保证开发中的各个问题能够按照开发制定的标准进行处理(比如:代码管理,版本冲突,代码命名规范等等)。
3)开发规范作为最终开发产品代码的检测标准,通过对最终产品代码的再次检测,来保证代码的规范性,可维护性。
开发规范作为开发中的检测标准,来约束开发人员的开发行为,达到在团队内部提高开发质量和减少开发成本的作用。
开发规范的要求
1)制定开发时要求对于要求的内容必须语义清晰,确保所制定的内容不会有歧义发生。
2)对于开发中说明性的内容,以图片说明为主,减少文字性的描述。
3)对于开发规范避免在项目开发后发生对代码命名,代码逻辑分层等部分内容的变更。
4)如果开发规范发生变更,确保项目团队内部所有的人员都按照最新的开发标准进行开发。
5)对于开发规范也要求进行版本管理。
开发规范的内容
作为一份比较理想的开发规范,必须具备有以下的开发内容:
1)开发平台的约定
a)开发操作系统环境和最总用户使用环境(包含ServicePack版本号)
b)开发工具版本
c)数据库类型已经版本
d)网络状态
e)版本控制工具
f)开发使用硬件环境和组成
g)开发规范的执行问题
2)工作方式的约定
a)开始工作前的行为(每天开始工作先update代码)
b)工作结束后的行为(每天结束后需要commit全部代码)
c)版本控制行为(代码commit的要求和发生冲突的解决办法)
d)文件保存要求(新增代码文件和备份文件的处理)
3)代码书写约定
a)代码的命名规则
b)代码的注释要求
c)代码的修改履历要求
d)代码的文件保存要求(一个类保存在一个文件中等)
e)代码的外观要求(代码的对齐,换行要求)
f)数据库代码的书写要求
4)程序的结构约定
a)通用代码的处理方式
b)接口的处理方式
c)代码的内部的逻辑划分要求
d)程序的分层结构要求
e)程序的异常处理要求
5)辅助工具的使用约定
a)版本控制工具使用说明
b)代码生成工具的使用说明
c)单元测试工具的使用说明
d)Bug管理工具的使用说明
6)其他约定
a)单元测试方法约定
b)版本控制约定
c)计划管理约定
d)测试数据的约定
开发规范的执行问题
1)制定问题
a)鼓励全部的项目开发人员都参与规范的制定
b)制定标准是需要考虑代码的维护性和实际开发的便利性
2)执行问题
a)依照开发规范对于代码进行检测,对于存在问题要求修正。
b)通过团队内部人员交叉检测的方式来执行开发标准