Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/zh-google-styleguide/zh-google-styleguide

Google 开源项目风格指南 (中文版)
https://github.com/zh-google-styleguide/zh-google-styleguide

Last synced: 10 days ago
JSON representation

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

Lists

README 

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

================================



* ReadTheDocs 托管地址： `在线阅读最新版本 `_



* GitHub 托管地址： `zh-google-styleguide `_



* 离线文档下载地址： `release `_



.. note:: 



    **声明**



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



    如果你关注的是 Google 官方英文版，请移步 `Google Style Guide `_ 。



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



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



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



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



#. `Google C++ 风格指南 `_



#. `Google Objective-C 风格指南 `_



#. `Google Python 风格指南 `_



#. `Google JavaScript 风格指南 `_



#. `Google Shell 风格指南 `_



#. `Google JSON 风格指南 `_



#. `Google TypeScript 风格指南 `_



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



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



* 另外，招募志愿者翻译 `JavaScript Style Guide `_ 以及 `XML Document Format Style Guide `_ ，有意者请联系 `Yang.Y `_ 。