美文网首页iOS开发IOS开发点滴
一个好的开发规范应该包含哪些内容

一个好的开发规范应该包含哪些内容

作者: 红胡子刚子 | 来源:发表于2016-01-28 16:12 被阅读129次

简述

开发规范是基于某种特定的开发语言和架构,进行开发的基本原则和推荐方式,在开发过程中有迷惑时进行参照的指南。
开发规范不同于编码规则,但一定要包含编码规则。

好的开发规范应该具有以下几个特征

1、明确书写和阅读的方式

1.1项目名或者是概要
规范中所要描述的项目和规定内容
说明:
关于该项目的说明或者是补充说明
理由:
进行规定的目的、或者想达到什么结果、以及该项目存在的理由。

2、明确工程文件构成

包括工程文件夹和各种类型的代码、资源文件的命名。
还有文件的编码方式(utf还是GB)。

3、编码规范

一般性约束

代码缩进方式
不同类型(私有、公有)函数的顺序
段落指示符(c#的#region 和OC的#pragma mark -)的运用
编码约束
全部变量的使用
变量的作用域:属性、实例变量、区部变量
枚举类型的值类型和初始值设定
函数的提取
去除残留代码和调试时的Log
减少对环境依赖的处理逻辑等

4、注释规范

注释的规范方针
和代码一致性原则
不同场合对不同类型注释(单行、多行、带参数等)的使用规定

5、异常处理

异常的封装
异常的后续处理(用户提示还是Log记录)

6、效率规范

针对不同语言的特点,禁止和提倡哪些用法
资源的使用和释放

7、UI规范

控件的命名
UI布局规范(从左到右从上到下、所属、内外间距等)

总结

好的开发规范不仅仅是明确基本的开发约束,还要提出哪些做法是项目推荐的哪些是做法是要摒弃的。同时还要对这些事项有足够的说明和理由。

开发规范的内容要根据项目中代码评审等发现的问题及时进行整理和补充。

相关文章

  • 一个好的开发规范应该包含哪些内容

    简述 开发规范是基于某种特定的开发语言和架构,进行开发的基本原则和推荐方式,在开发过程中有迷惑时进行参照的指南。开...

  • 从零搭建项目开发框架-02框架设计

    首先界定开发框架都包含哪些内容: 权限控制 日志、异常处理 开发规范 等等 权限控制这里采用基于RBAC(Role...

  • 原型应该包含哪些内容

    随着互联网节奏越来越快,传统的需求文档已经比较难适应市场的脚步,特别对于要求敏捷的团队来说,冗余而细致入微的需求文...

  • 自学大数据:大数据最新学习路线

    你有了解清楚大数据课程应该包含哪些内容嘛?其中哪些又是重点必学的内容呢? 大数据开发最核心的课程就是Hadoop框...

  • 开发提测邮件模板

    在平时测试中经常会遇到开发提测的问题,到底开发的提测邮件应该包含哪些内容呢,我在下面给大家提供一个模板,希望能给大...

  • 开发一个Magento 2 网站包含哪些内容?

    把Magento 2 网站开发出来可能需要数百甚至数千小时。虽然开发是其中的一个重要部分,但还需许多其他“领域”的...

  • 阿里编程规约之集合处理

    今天我们一起要阅读的是开发规范中集合处理,首先大概看一下里面涉及到集合的哪些内容,脑图如下 从上图来看,开发规范其...

  • 软件定制开发流程包含的内容有哪些?

    刚刚接触到软件开发的人,可能对软件开发的合作流程并不是特别了解,以下我们就来逐步的做下了解,定制开发流程包含的内容...

  • npm package开发指南-包内容篇

    假设我们要开发一个 npm 库,名字叫 lib-dev-tutorial,那么需要包含哪些内容?我们下面就来列举下...

  • HTML超文本标记语言

    参考资料 W3C Html规范进阶 基本规范 一个HTML文件不仅包含文本内容,还包含一些Tag,中文称“标记”。...

网友评论

    本文标题:一个好的开发规范应该包含哪些内容

    本文链接:https://www.haomeiwen.com/subject/wskjkttx.html