编码规范集锦

标签: 编码风格指导 文档手册 编码规范 编码标准 | 发表时间:2013-04-07 23:20 | 作者:Aqee
出处:http://www.aqee.net
编码规范

真的不知道我的第一篇真正的文章应该以什么为主题。我最终选择了编码规范。

编码规范是什么?

简单说——编码规范是一种…规范。通过建立起一种通用的约定和模式,所有人都遵循,以此帮助打造健壮的软件。

使用编码规范有什么好处?

有很多好处,包括(不仅限于此):

  1. 保持编码风格,注释风格一致,应用设计模式一致
  2. 新程序员,通过熟悉你们的编码规范,可以更容易、更快速的掌握你们的程序基础库。
  3. 减少代码中bug出现的可能性,因为程序员遇到各种情况时有标准可以简单的遵循,有现成的参考。
  4. 防止利用晦涩难懂的语言功能创造不良代码。例如,C++是一种语言猛兽。有些程序员也许会使用诸如模板和异常等语言功能,尽管这些不是很深奥的语言用法,但仍能产生意想不到的性能问题。
  5. 遵循业界广泛采用的编码规范更容易获得辅助工具。
  6. 更容易生成文档。例如,如果项目中的每个人都按照Doxygen格式写注释,你可以轻易的让程序为你的代码生成文档。

使用编码规范还有其它很多好处,在这里一一列出是不可能的。下面是一些被业界广泛采用的编码规范:

  1. 谷歌编码风格指导 – 包括针对各种语言的编码风格指导,比如C++,Python,ShellScript,Javascript等。我喜欢谷歌的风格指导的原因是,它给读者同时提供了这些编码风格建议的好的和不好的方面。所以请记住,这些编码规范并不是在任何场合都合适。
  2. 美国太空总署喷气推进实验室提供的一些编码规范指导,当然,他们是开发火箭和宇宙飞船的,所以,他们的指导并不是对所有人都合适,但还是非常有趣的。特别要提到,他们正在起草一个针对Java的编码规范。
  3. Linux内核编码风格 – 我很吃惊,他们使用8个tab键缩进,要知道,这可是相当宽的缩进。
  4. Perl语言编码风格指导 – 它提供了Perl程序形式上的风格指导。我最近在网上遇到了各种关于它的争论,尽管我不喜欢Perl(它有它的缺陷),我仍然为它具有惊人多的文档而印象深刻。我开始相信它是一个高质量的语言。Perl提供了各种各样的工具来生成文档,比如 perlcritic
  5. GNU编码规范 – 主要是格式上的规范,也包含一些关于编程错误预防和编程一致性上的最佳实践方法。

本文由 外刊IT评论网( www.aqee.net)原创发表,文章地址: 编码规范集锦,[英文原文: Coding standards ]







相关 [编码 规范] 推荐:

java编码规范

- - ITeye博客
   总结前期做的几个项目,个人认为代码的规范对团队的协作有着密切的关系. 现将一些常用的约束总结如下,以便今后参阅:. 1、所有的类、属性、方法都遵守以字母和数字为主,尽量不要参与特殊符号如下划线. 其次,除类名开头字母大写外,其他名字都要小写,然后第二个后的单词首字母大写,长度在30个字符以内.

oracle 编码规范

- - 操作系统 - ITeye博客
军规一:【恰当控制事务大小,commit不要过于频繁. 】 军规二:【在OLTP系统中一定要注意使用绑定变量. 】 军规三:【在OLTP系统中一定要注意复杂的多表关联不宜超过4个,关联十分复杂时,需要拆分成多个步骤,防止执行计划不正确. 】 军规四:【合理收集统计信息,固定住SQL的执行计划. 】 军规五:【尽量避免使用XA事务,在RAC环境中要避免XA事务跨节点操作.

HTML编码规范

- - SegmentFault 最新的文章
这段时间在整理前端部分代码规范,初步想法是从HTML、CSS、Javascipt、项目文件目录四部分是整理. 之前已经整理完了 CSS编码规范,有兴趣可以了解下. [强制] 使用 4 个空格做为一个缩进层级,不允许使用 2 个空格 或 tab 字符. 对于非 HTML 标签之间的缩进,比如 script 或 style 标签内容缩进,与 script 或 style 标签的缩进同级.

JavaScript之编码规范

- - CSDN博客推荐文章
   JavaScript是一种语法灵活,简单易懂的脚本语言. 正因为灵活,因此很多人在编写代码时,显得很随意,这就导致后期的修改、扩展和维护变得异常困难. 遵循统一的编码规范,不仅对C++和Java这种编译型语言很重要,对JavaScript脚本语言也同样如此.       1、应给变量和函数取一个含义确切的名称,不要随意命名.

Java/Android编码规范

- - CSDN博客推荐文章
1.        为什么需要编码规范?. 编码规范对于程序员而言尤为重要,有以下几个原因:. l        一个软件的生命周期中,80%的花费在于维护. l        几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护. l        编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码.

编码规范集锦

- - 外刊IT评论
真的不知道我的第一篇真正的文章应该以什么为主题. 简单说——编码规范是一种…规范. 通过建立起一种通用的约定和模式,所有人都遵循,以此帮助打造健壮的软件. 有很多好处,包括(不仅限于此):. 保持编码风格,注释风格一致,应用设计模式一致. 新程序员,通过熟悉你们的编码规范,可以更容易、更快速的掌握你们的程序基础库.

Object-C编码规范

- - 编程语言 - ITeye博客
▪ 如:NSString *varName;. ▪ 只允许使用空格,将编辑器设置为1个TAB = 2个字符缩进. ▪ 每行最多不得超过100个字符. ▪ 以15寸Macbook Pro的大小,每行100个字符时能最大化地同时容下编辑器和iPhone模拟器. ▪ Google的80字符的标准有点少,这导致过于频繁的换行(Objectve-C的代码一般都很长).

编码风格不是编码规范

- - 外刊IT评论
我并不认为程序员是一个情绪特别丰富的群体. 但有一些事情却能很容易刺激程序员的神经,那就是代码格式和布局. 如果看到一个函数的括弧在同一行上没有闭合,我的眼睛会喷血. 如果看到有人没有 恰好的在两个函数间留一空行,我的小腿会抽筋. 但重点在这里——除非是在家里开发自己的业余爱好软件,我的这些个人喜好其实是无关紧要的.