编码规范集锦

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

编码规范是什么?

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

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

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

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

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

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

7 Responses to 编码规范集锦

  1. p31 says:

    “Tabs are 8 characters, and thus indentations are also 8 characters.”
    这个不是说 Linux 内核编码规范要用 8 个Tab,而是说 Tab 是8个字符。

  2. p31 says:

    “他们使用8个tab键缩进”
    “Tabs are 8 characters, and thus indentations are also 8 characters.”

    不是一个意思,相差太远了。

  3. C says:

    8個字元吧…
    不是8個tab
    8個字元在大多的編輯器應該是2個tab
    當然它指的應該是在C語言中”\t”,即縮至下一個8字元位置
    ->Tabs are 8 characters, and thus indentations are also 8 characters.

  4. rene says:

    额,这能算是文章么。。。。

  5. 秒大刀 says:

    过于复杂的规范就等于没规范,懒得记住的规范会让人懒得编码

发表评论

电子邮件地址不会被公开。 必填项已用*标注