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

原始路径: /工作相关/zh-google-styleguide-20201118.epub
文件大小: 272 KB
版本: 4.45
处理日期: 2026-09-19
处理方式: EPUB 解压 + XML 提取
状态: done


核心内容

简介

Google 开源项目风格指南是 Google 制定的编程规范,适用于其主导的开源项目。中文版由社区志愿者翻译维护,涵盖多门编程语言。

包含语言指南

语言章节
C++最详尽,涵盖头文件、作用域、类、函数、命名、注释、格式等
Objective-CiOS/macOS 开发规范
PythonPython 语言规范和风格规范
ShellShell 脚本编写规范
JavaScriptJavaScript 代码规范
HTML/CSSWeb 前端开发规范

C++ 风格指南核心要点

1. 头文件

  • Self-contained 头文件
  • 使用 #pragma once 保护
  • 前置声明优于 #include
  • #include 路径和顺序有严格规定

2. 命名约定

  • 文件命名:snake_case.h / snake_case.cc
  • 类型命名:PascalCase
  • 变量命名:snake_case
  • 常量命名:const 或 constexpr
  • 函数命名:camelCase 或 snake_case(根据风格)

3. 注释规范

  • 文件头注释
  • 类注释
  • 函数注释
  • TODO 注释格式
  • 避免不必要的注释

4. 代码格式

  • 行长度限制(通常 80 或 100 字符)
  • 缩进:4 空格
  • 大括号风格
  • 空格使用规范

5. 特殊规则

  • 避免使用全局变量
  • 谨慎使用继承
  • 优先使用智能指针
  • C++11/14/17 新特性使用建议

价值评估

这是一份权威的编程规范参考文档,适合:

  • 团队代码规范制定
  • 个人代码风格学习
  • Code Review 参考标准

关联笔记