二、注释

1、注释

1.1、块注释

“#”号后空一格，段落件用空行分开（同样需要“#”号）

  1. # 块注释
  2. # 块注释
  3. #
  4. # 块注释
  5. # 块注释

1.2、行注释

至少使用两个空格和语句分开，注意不要使用无意义的注释

  1. # 正确的写法
  2. x = x + 1  # 边框加粗一个像素
  4. # 不推荐的写法(无意义的注释)
  5. x = x + 1 # x加1

1.3、建议

  • 在代码的关键部分(或比较复杂的地方), 能写注释的要尽量写注释

  • 比较重要的注释段, 使用多个等号隔开, 可以更加醒目, 突出重要性

  1. app = create_app(name, options)
  4. # =====================================
  5. # 请勿在此处添加 get post等app路由行为 !!!
  6. # =====================================
  9. if __name__ == '__main__':
  10.     app.run()

2、文档注释（Docstring）

作为文档的Docstring一般出现在模块头部、函数和类的头部，这样在python中可以通过对象的__doc__对象获取文档. 编辑器和IDE也可以根据Docstring给出自动提示.

  • 文档注释以 “”” 开头和结尾, 首行不换行, 如有多行, 末行必需换行, 以下是Google的docstring风格示例
  1. # -*- coding: utf-8 -*-
  2. """Example docstrings.
  4. This module demonstrates documentation as specified by the `Google Python
  5. Style Guide`_. Docstrings may extend over multiple lines. Sections are created
  6. with a section header and a colon followed by a block of indented text.
  8. Example:
  9.     Examples can be given using either the ``Example`` or ``Examples``
  10.     sections. Sections support any reStructuredText formatting, including
  11.     literal blocks::
  13.         $ python example_google.py
  15. Section breaks are created by resuming unindented text. Section breaks
  16. are also implicitly created anytime a new section starts.
  17. """
  • 不要在文档注释复制函数定义原型, 而是具体描述其具体内容, 解释具体参数和返回值等
  1. #  不推荐的写法(不要写函数原型等废话)
  2. def function(a, b):
  3.     """function(a, b) -> list"""
  4.     ... ...
  7. #  正确的写法
  8. def function(a, b):
  9.     """计算并返回a到b范围内数据的平均值"""
  10.     ... ...
  • 对函数参数、返回值等的说明采用numpy标准, 如下所示
  1. def func(arg1, arg2):
  2.     """在这里写函数的一句话总结(如: 计算平均值).
  4.     这里是具体描述.
  6.     参数
  7.     ----------
  8.     arg1 : int
  9.         arg1的具体描述
  10.     arg2 : int
  11.         arg2的具体描述
  13.     返回值
  14.     -------
  15.     int
  16.         返回值的具体描述
  18.     参看
  19.     --------
  20.     otherfunc : 其它关联函数等...
  22.     示例
  23.     --------
  24.     示例使用doctest格式, 在`>>>`后的代码可以被文档测试工具作为测试用例自动运行
  26.     >>> a=[1,2,3]
  27.     >>> print [x + 3 for x in a]
  28.     [4, 5, 6]
  29.     """

  • 文档注释不限于中英文, 但不要中英文混用

  • 文档注释不是越长越好, 通常一两句话能把情况说清楚即可

  • 模块、公有类、公有方法, 能写文档注释的, 应该尽量写文档注释