[关闭]
@zzy0471 2018-04-13T12:03:07.000000Z 字数 1205 阅读 1082

Python乱记第十二:推荐编码规范

Python


缩紧

用四空格缩紧,避免使用tab。实际上有些编辑器会将tab自动转换为四个空格

空行

空格

Shebang

大部分.py文件不必以#!作为文件的开始,程序的main文件应该以 #!/usr/bin/python2或者 #!/usr/bin/python3开始

注释

文档注释

使用三引号包围文档,一个文档字符串应该这样组织: 首先是一行以句号, 问号或惊叹号结尾的概述(或者该文档字符串单纯只有一行). 接着是一个空行. 接着是文档字符串剩下的部分, 它应该与文档字符串的第一行的第一个引号对齐,如:

class Person(object):
    ''' 人的莫板类.

    该类包含了领域“人”的基本属性和行为
    '''

块注释和行注释

class Person(object):

    ''' 人的莫板类.

    该类包含了领域“人”的基本属性和行为
    '''
    def call(self, message):
        print(message) #单行注释

    def want_to_say(self, message):
        #其实我觉得或者就是一直在想办法赚钱,但有些钱真的不要赚,
        #我今年年初的时候小学同学让我去她公司当了一周客服,她公
        #司是卖一个什么治高血压的东西,其他的不说了大家都懂,购买客
        #户大多都是老年人,我实在接受不了所以离开了,个人觉得哪怕
        #再穷有些钱还是不可以赚的
        pass

字符串

Yes: x = a + b
     x = '%s, %s!' % (imperative, expletive)
     x = '{}, {}!'.format(imperative, expletive)
     x = 'name: %s; score: %d' % (name, n)
     x = 'name: {}; score: {}'.format(name, n)

No: x = '%s%s' % (a, b)  # use + in this case
    x = '{}{}'.format(a, b)  # use + in this case
    x = imperative + ', ' + expletive + '!'
    x = 'name: ' + name + '; score: ' + str(n)

已上代码拷贝自:Python 编码规范(Google)

import格式

导入总应该放在文件顶部, 位于模块注释和文档字符串之后, 模块全局变量和常量之前. 导入应该按照从最通用到最不通用的顺序分组:

  1. 标准库导入
  2. 第三方库导入
  3. 应用程序指定导入

命名约束

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注