123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354 |
- 本文《吉赫软件代码规范(C++)》是基于开源的Google代码规范修改的,几乎保留了所有的Google规范,做了一些删减(一些可选的规范只保留其中一个作为标准)。文件是使用代码编译成的PDF文件,如需修改请从源代码上进行修改并重新生成不需要编辑PDF。
- 推荐在linux系统中编译,编译前需要在linux系统中安装环境和字体,环境和字体需要查看manually-generate-pdf-document文件。
- 在Windows环境生成PDF时需要先将文件编译成latex格式,再将latex文件编译成PDF文件。
- 参考来源:
- Google 开源项目风格指南——中文版
- ================================
- * ReadTheDocs 托管地址: `在线阅读最新版本 <https://zh-google-styleguide.readthedocs.io/en/latest/>`_
- * GitHub 托管地址: `zh-google-styleguide <https://github.com/zh-google-styleguide/zh-google-styleguide>`_
- * 离线文档下载地址: `release <https://github.com/zh-google-styleguide/zh-google-styleguide/releases>`_
- .. note::
- **声明**
- 本项目并非 Google 官方项目,而是由国内程序员凭热情创建和维护。
- 如果你关注的是 Google 官方英文版,请移步 `Google Style Guide <https://github.com/google/styleguide>`_ 。
- 每个较大的开源项目都有自己的风格指南:关于如何为该项目编写代码的一系列约定(有时候会比较武断)。当所有代码均保持一致的风格,在理解大型代码库时更为轻松。
- “风格”的含义涵盖范围广,从“变量使用驼峰格式(camelCase)”到“决不使用全局变量”再到“决不使用异常”,等等诸如此类。
- 英文版项目维护的是在 Google 使用的编程风格指南。如果你正在修改的项目源自 Google,你可能会被引导至英文版项目页面,以了解项目所使用的风格。
- 我们已经发布了七份 **中文版** 的风格指南:
- #. `Google C++ 风格指南 <http://zh-google-styleguide.readthedocs.org/en/latest/google-cpp-styleguide/>`_
- #. `Google Objective-C 风格指南 <http://zh-google-styleguide.readthedocs.org/en/latest/google-objc-styleguide/>`_
- #. `Google Python 风格指南 <http://zh-google-styleguide.readthedocs.org/en/latest/google-python-styleguide/>`_
- #. `Google JavaScript 风格指南 <https://zh-google-styleguide.readthedocs.io/en/latest/google-javascript-styleguide/contents/>`_
- #. `Google Shell 风格指南 <http://zh-google-styleguide.readthedocs.org/en/latest/google-shell-styleguide/>`_
- #. `Google JSON 风格指南 <https://github.com/darcyliu/google-styleguide/blob/master/JSONStyleGuide.md>`_
- #. `Google TypeScript 风格指南 <https://zh-google-styleguide.readthedocs.io/en/latest/google-typescript-styleguide/contents/>`_
- 中文版项目采用 reStructuredText 纯文本标记语法,并使用 Sphinx 生成 HTML / CHM / PDF 等文档格式。
- * 英文版项目还包含 `cpplint <https://github.com/google/styleguide/tree/gh-pages/cpplint>`_ ——一个用来帮助适应风格准则的工具,以及 `google-c-style.el <https://raw.githubusercontent.com/google/styleguide/gh-pages/google-c-style.el>`_,Google 风格的 Emacs 配置文件。
- * 另外,招募志愿者翻译 `JavaScript Style Guide <http://google.github.io/styleguide/javascriptguide.xml>`_ 以及 `XML Document Format Style Guide <http://google.github.io/styleguide/xmlstyle.html>`_ ,有意者请联系 `Yang.Y <https://github.com/yangyubo>`_ 。
|