欢迎来到风尚网
风尚网首页 > 首页 > 阅读 > 一个好的开发规范应该包含哪些内容

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

作者:红胡子刚子 2016-02-21 07:12 来源:简书 编辑:美朵

文章摘要
简述开发规范是基于某种特定的开发语言和架构,进行开发的基本原则和推荐方式,在开发过程中有迷惑时进行参照的指南。开发规范不同于编码规则,但一定要包含编码规则。好的开发规范应该具有以下几个特征1、明确书写和阅读的方式1.1项目名或者是概要规范中所要描述的项目和规定内容说明:关于该项目的说明或者是补充说明理由:进行规定的目的、或者想达到什么结果、以及该项目存在的理由。2、明确工程文件构成包括工程文件夹和各种类型的代码、资源文件的命名。还有文件的编码方式(utf还是GB)。3、编码规范一般性约束代码缩进...

简述

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

开发规范不同于编码规则,但一定要包含编码规则。

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

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

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

2、明确工程文件构成

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

3、编码规范

一般性约束

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

4、注释规范

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

5、异常处理

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

6、效率规范

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

7、UI规范

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

总结

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

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

小主,按键盘右方向键 → 翻页可以跳过片头呢

  

上一篇:OneNote重现理性与自由,笔记中的王者归来

  

下一篇:设计一个带提示信息的导航栏控件HTNavGlideBar

  

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

原文链接:http://i.she.vc/28710.html

和本文相似的内容:

点击排行