[collect]开源项目编程风格指南

本文最后更新于2015年8月2日,已超过 1 年没有更新,如果文章内容失效,还请反馈给我,谢谢!

==Google 开源项目风格指南 (中文版)==
声明:

本项目并非 Google 官方项目,而是由国内程序员凭热情创建和维护。

如果你关注的是 Google 官方英文版,请移步 Google Style Guide

每个较大的开源项目都有自己的风格指南:关于如何为该项目编写代码的一系列约定 (有时候会比较武断)。当所有代码均保持一致的风格,在理解大型代码库时更为轻松。

“风格” 的含义涵盖范围广,从 “变量使用驼峰格式 (camelCase)” 到 “决不使用全局变量” 再到 “决不使用异常”。英文版项目维护的是在 Google 使用的编程风格指南。如果你正在修改的项目源自 Google,你可能会被引导至英文版项目页面,以了解项目所使用的风格。

我们已经发布了四份 中文版 的风格指南:

  1. Google C++ 风格指南
  2. Google Objective-C 风格指南
  3. Google Python 风格指南
  4. Google JSON 风格指南

中文版项目采用 reStructuredText 纯文本标记语法,并使用 Sphinx 生成 HTML / CHM / PDF 等文档格式。

英文版项目还包含 cpplint —— 一个用来帮助适应风格准则的工具,以及 google-c-style.el,Google 风格的 Emacs 配置文件。

另外,招募自愿者翻译 JavaScript Style Guide 以及 XML Document Format Style Guide,有意者请联系 brantyoung

原文链接:

http://zh-google-styleguide.readthedocs.org/en/latest/

==

除了以上Google家的编程风格指南,国内的厂商华为也有几份不错的指南/规范可以参考学习:

=EOF=

声明: 除非注明,ixyzero.com文章均为原创,转载请以链接形式标明本文地址,谢谢!
https://ixyzero.com/blog/archives/2470.html

《[collect]开源项目编程风格指南》上有7条评论

  1. 代码质量管控的四个阶段
    https://zhuanlan.zhihu.com/p/29086959

    代码质量管控通常需要经历的四个阶段:
    规范化 - 建立代码规范与Code Review制度
    自动化 - 使用工具自动检查代码质量
    流程化 - 将代码质量检查与代码流动过程绑定
    中心化 - 以团队整体为视角,集中管理代码规范,并实现质量状况透明化

发表评论

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