针对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)通过团队内部人员交叉检测的方式来执行开发标准
要有规矩才能更有效率的完成任务,但其中也不乏创意。
分享到:
相关推荐
阿里巴巴开发规范 一、编程规约 1 (一) 命名规约 1 (二) 常量定义 3 (三) 格式规约 4 (四) OOP 规约 6 (五) 集合处理 10 (六) 并发处理 12 (七) 控制语句 15 (八) 注释规约 16 (九) 其它 17 二、异常日志...
NET 开发规范(参考阿里开发规范),
Vue前端开发规范
医保信息系统安全开发规范。本规范用于规范和统一医疗保障信息系统生命周期各阶段(包括:安全需求分析、系统安全设计、 系统开发安全、系统安全测试和系统部署上线等阶段)需执行的安全控制及安全任务,明确系统...
参考阿里巴巴开发规范整理
阿里前端开发规范.pdf
阿里开发规范最新,2021年
Hive开发规范及要点,hql 开发基础知识,规范
阿里开发规范插件,可以嵌入到eclipse中,检测代码规范性
阿里巴巴JAVA开发规范word 编程规约 异常日志 MySQL 规约 工程规约 阿里巴巴JAVA开发规范word 编程规约 异常日志 MySQL 规约 工程规约 阿里巴巴JAVA开发规范word 编程规约 异常日志 MySQL 规约 工程规约 阿里巴巴...
前端开发规范文档_pdf文件,开发规范命名相关,提高代码的阅读能力,以及规范性,团队协作能力,前端必备技能之一。
OA界面开发规范OA界面开发规范OA界面开发规范
c# Winform应用程序开发规范c# Winform应用程序开发规范c# Winform应用程序开发规范
Net开发规范.pptNet开发规范.pptNet开发规范.pptNet开发规范.pptNet开发规范.pptNet开发规范.pptNet开发规范.pptNet开发规范.ppt
共61页,划分为编程规约、异常日志、 单元测试、 安全规约、 MySQL 数据库、 工程结构、 设计规约七个维度,再根据内容特征,细分成若干二级子目录。涉及到大多数开发规范的约定。
国家标准-软件开发规范文档,28个文档 1.任务申请.doc 2.可行性与计划阶段--可行性研究报告.doc 2.可行性与计划阶段--项目开发计划.doc 2.软件质量保证计划编写规范.doc 3.数据要求说明书编写规范.doc 3.软件需求说明...
GB8566-88 计算机软件开发规范 目的:详细规定计算机软件开发过程胡各个阶段及没法儿阶段胡任务、 实施步骤、实施要求 、完成标志及交付文件。为软件开人员和管理人员提供一系列之有效的准则、方法和规范。
Web前端开发规范手册
hive常用的开发规范 hdfs hbase udf函数 hql shell脚本开发等常用规范,仅供参考