• Python中的编码风格


    详细内容参照:https://www.python.org/dev/peps/pep-0008/

    要点提取:

    1、使用 4 个空格缩进,严禁Tab和空格两者混用,如果使用 tab 缩进,设定tab 为 4 个空格。

    2、4 个空格是小缩进(允许更大的嵌套深度)和大缩进(更容易阅读)之间的一个很好的折衷。Tab会引起混乱,最好不要使用。

    3、换行,使其不超过 79 个字符,这有助于使用小显示器的用户,并可以在较大的显示器上并排放置多个代码文件。

    4、使用空行来分隔函数和类,以及函数内部的较大代码块。

    5、如果可能的话,将注释写在一行中。

    6、使用文档字符串,文档字符串使用惯例:它的首行简述函数功能,第二行空行,第三行为函数的具体描述。如:

    def printMax(x,y):
        '''打印两个数中的最大值。
        
        两个值必须都是在整形数。'''
        x=int(x)
        y=int(y)
        if x>y:
            print(x,'最大')
        else:
            print(y,'最大')
            
    printMax(3,5)
    print (printMax.__doc__) # 调用 doc 

    7、在运算符周围和逗号后使用空格,但不要直接在括号结构内使用:.f(1, 2) g(3, 4)

      注意点: 

    在二元算术、逻辑运算符前后加空格:如:a = b + c;
    在一元前缀运算符后不加空格,如:
    if !flg: pass;
    “:”用在行尾时前后皆不加空格,如分枝、循环、函数和类定义语言;用在非行尾时两端加空格,如:
      dict 对象的定义:d
    = {'key' : 'value'}   括号(含圆括号、方括号和花括号)前后不加空格,如:do_something(arg1, arg2),而不是:do_something( arg1, arg2 ) 不要在逗号、分号、冒号前面加空格,但应该在它们后面加(除了在行尾)
    不要用空格来垂直对齐多行间的标记,因为这会成为维护的负担(适用于:,
    #,=等)

    8、一致地命名您的类和函数,约定的是:

    类:单词首字母总是大写,私有类可以下划线开头。如:UpperCamelCase。
    
    函数:函数名一律小写,若有多个单词用下划线隔开。如:lowercase_with_underscores。另外,私有函数下划线开头 。如:_lowercase_with_underscores

    9、如果您的代码打算在国际环境中使用,请不要使用花哨的编码。在任何情况下,Python 的默认值、UTF-8 甚至纯 ASCII 都效果最好。

    同样,如果使用不同语言的人阅读或维护代码的可能性很小,则不要在标识符中使用非 ASCII 字符。

     
    学而时习之不亦说乎!
  • 相关阅读:
    源代码的下载和翻译
    Git使用入门
    搭建Andriod开发环境
    Andriod系统移植与驱动开发概述
    直观打印二叉树
    深度优先遍历图(DFS)
    《UNIX网络编程 卷1 套接字联网API》(第三版)阅读笔记----2018.5.22
    C/C++
    实现具有getMin功能的栈
    用两个栈来模拟一个队列
  • 原文地址:https://www.cnblogs.com/wxinyu/p/14919012.html
Copyright © 2020-2023  润新知