Google代码规范节选——Python可用

Google代码规范节选——Python可用

Google 开源项目风格指南 (中文版)：https://zh-google-styleguide.readthedocs.io/en/latest/
英文版：http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml
中文版：http://zh-google-styleguide.readthedocs.org/en/latest/google-cpp-styleguide/
google c++ 编码规范：http://blog.csdn.net/xiexievv/article/details/50972809
PDF 版下载地址：https://pan.baidu.com/s/1i3gc7lF

一、命名约定

1. 通用命名规则

• 函数命名、变量命名、文件命名要有描述性

• 少用缩写

  price_count_reader

  num_errors

  num_dns_connection

2. 文件命名

• 全部小写

• 可以包含 ‘_’ 或 ’-‘ ，按项目约定来

• 默认用‘ _ ’ 更好

  price_count.py

  write_file.py

3. 类命名

• 每个单词首字母大写，不包含 ’ _ ‘

  class UrlTable():

4. 变量命名

• 一律小写，单词与单词之间下划线连接

• 类成员变量以下划线结尾

• 全局变量加g_前缀

  普通：

  tablename

  table_name

  类成员变量：

  tablename_

  table_name_

  全局变量：

  g_table_name

5. 常量命名

• 加前缀k（小写）
• 除开头的k之外每个单词首字母大写

6. 函数命名

1. 常规函数

   每个单词首字母大写，不包含下划线

   AddTableEntry()

2. 取值与设值函数

   与类成员变量相对应

   变量：num_entries_

   取值函数： num_entries()

   设值函数： set_num_entries()

二、 注释

1. 注释风格

• 要么全部使用#，要么全部使用’’’ ‘’’

2. 文件注释

• 版权
• 许可版本
• 作者

3. 类注释

• 附着描述类的功能和用法的注释

4. 函数注释

• 函数声明处注释描述函数功能
• 函数定义处注释描述函数实现

1. 函数声明
   描述函数功能及用法，即什么情况下使用该函数
2. 函数定义
   说明函数实现的要点，即实现的简要步骤，这么实现的理由等

5. 变量注释

• 通用变量的命名本身就足以说明变量用途
• 特定情况下额外注释说明

6. TODO注释

• 对临时的项目做的注释

  TODO（邮箱）：123@132.com
  TODO（名字）：Mengc