Skip to content
master
Switch branches/tags
Code

Google 开源项目风格指南——中文版

Note

声明

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

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

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

“风格”的含义涵盖范围广,从“变量使用驼峰格式(camelCase)”到“决不使用全局变量”再到“决不使用异常”,等等诸如此类。

英文版项目维护的是在 Google 使用的编程风格指南。如果你正在修改的项目源自 Google,你可能会被引导至英文版项目页面,以了解项目所使用的风格。

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

  1. Google C++ 风格指南
  2. Google Objective-C 风格指南
  3. Google Python 风格指南
  4. Google JavaScript 风格指南
  5. Google Shell 风格指南
  6. Google JSON 风格指南
  7. Google TypeScript 风格指南

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