培训讲义--开发规范(01_02)

简介:
前一篇文章中对于团队做了讲解, (文章参照)
针对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)通过团队内部人员交叉检测的方式来执行开发标准














本文转自小余(Yice)博客园博客,原文链接: http://www.cnblogs.com/yice/archive/2008/04/17/936466.html   ,如需转载请自行联系原作者



相关文章
|
5月前
|
分布式计算 安全 搜索推荐
阿里大牛评:入门到大成!GitHub新上线并发编程深度解析实战PDF
众所周知,在很多一二线互联网公司的面试中,并发编程几乎是必然会问的问题,而绝大部分程序员对并发编程的理解也都停留在使用阶段。 市面上几乎所有有关并发编程的书,通过搜索引擎查找了几乎所有的并发编程学习资料,展现的并发编程这个领域知识体系非常庞大。同时,随着对并发编程的深入研究,会发现里面有大量的设计思想(比如分而治之)非常值得学习和研究。
|
7月前
|
缓存 Java 程序员
面试进阶齐飞!Github一天万赞的阿里Java系统性能优化有多牛?
前两天在知乎上看到一个问答,说的是: 一个Java程序员具备什么样的素质和能力才可以称得上高级工程师? 这个问题也引发了我的一些思考,可能很多人会说,“作为高级工程师,基础得过硬、得熟练掌握一门编程语言、至少看过一个优秀开源项目的源代码、有过高并发/性能优化的工作经验、沟通能力强等等”。
55 0
|
5月前
|
消息中间件 设计模式 分布式计算
大厂招聘重点全在这!GitHub置顶Java基础-高级面试库+自学路线
最近几年经常会听见这样一种声音:“程序员是吃青春饭的,年龄一大就不吃香了”,在当下这种互联网产业增速放缓,甚至隐约展现出疲态的时刻,此类言论就很有市场。
|
6月前
|
C++
[笔记]c++基础实践《四》chrono库使用
[笔记]c++基础实践《四》chrono库使用
|
8月前
|
缓存 架构师 Java
GitHub标星百万的Java进阶架构师手册,用20%技术解决80%问题?
在程序员的现实世界里不想当架构师的程序员不是好程序员
145 0
|
9月前
|
开发框架 监控 NoSQL
阿里内部SpringBoot进阶宝典横空出世,实战源码齐飞
想必大家都知道使用SpringBoot的最大好处就是简化配置,它实现了自动化配置。它简化了Spring应用开发,不需要配置就能运行Spring应用,无论是简单的Web系统,还是构建复杂系统,都只需要少量配置和代码就能完成。这有点像每个公司基于Spring框架做的内部开发框架,不同的是,Spring Boot更完善、更强大。
|
10月前
|
安全 Java Serverless
65w字!阿里分布式开发小册Github新开源!原理实践双飞
我们都知道传统的集中式系统已无法满足当今的互联网三高需求,所以现在的系统架构都是向着分布式系统不断演进。同时,越来越多的企业选择通过云的方式发布和部署应用,这也大大促进了分布式系统的发展。未来将是分布式系统“爆发”的时代。
|
10月前
|
消息中间件 NoSQL 算法
基础到高级涵盖11个技术,Alibaba最新出品711页Java面试神册真香
很多人都说八股文没用,这里聊一下我对八股文的一些看法吧:一个知识点,你能把使用以及原理说出来,我称之为八股,但是你能把底层关联以及业务使用,优化历程也能搞清楚,我称之为能力;这两点无疑是现在面试都会考察的。
|
11月前
|
SQL 缓存 分布式计算
GitHub上超屌的Java进阶教程,Java核心技术及大公司架构案例汇总
汇总Java生态圈常用技术框架、开源中间件,系统架构、数据库、大公司架构案例、常用三方类库、项目管理、线上问题排查、个人成长、思考等知识
|
移动开发 缓存 JavaScript
「 前端开发规范 」10人小团队前端开发规范参考这篇就够了!
引自《阿里规约》的开头片段: ----现代软件架构的复杂性需要协同开发完成,如何高效地协同呢?无规矩不成方圆,无规范难以协同,比如,制订交通法规表面上是要限制行车权,实际上是保障公众的人身安全,试想如果没有限速,没有红绿灯,谁还敢上路行驶。对软件来说,适当的规范和标准绝不是消灭代码内容的创造性、优雅性,而是限制过度个性化,以一种普遍认可的统一方式一起做事,提升协作效率,降低沟通成本。代码的字里行间流淌的是软件系统的血液,质量的提升是尽可能少踩坑,杜绝踩重复的坑,切实提升系统稳定性,码出质量。
20358 4
「 前端开发规范 」10人小团队前端开发规范参考这篇就够了!