Python开发规范

命名规范

 

命名规范

	规范	例子
全局变量	全部大写+下划线	CAPS_WITH_UNDER
函数、变量名、包、模块	全部小写+下划线	lower_with_under
类、Exception	开头大写+驼峰	CapWords

①用单下划线(_)开头表示模块变量或函数是protected的(使用import * from时不会包含).

②用双下划线(__)开头的实例变量或方法表示类内私有.

 

注释规范

文档字符串注释

"""A user-created :class:`Response <Response>` object.
    
Used to xxx a :class: `JsonResponse <JsonResponse>`, which is xxx

:param data: response data
:param file: response files
    
Usage::

    >>> import api
    >>> rep = api.Response(url="http://www.baidu.com")
"""

行内注释

两个或两个以上空格 加 ‘#’ 空格

TODO注释

TODO注释应该在所有开头处包含”TODO”字符串, 紧跟着是用括号括起来的你的名字, email地址或其它标识符. 然后是一个可选的冒号. 接着必须有一行注释, 解释要做什么

如果你的TODO是”将来做某事”的形式, 那么请确保你包含了一个指定的日期(“2009年11月解决”)或者一个特定的事件 

# TODO(kl@gmail.com): Use a "*" here for string repetition.
# TODO(Zeke) Change this to use relations.