Python 代码规范

PEP8 => python enhanced proposal 8

python增强规范8

代码规范: 缩进,用 4 个空格,不要用制表符(tab键)。

4 个空格是小缩进(更深嵌套)和大缩进(更易阅读)之间的折中方案。

制表符会引起混乱,最好别用。

换行,一行不超过 79 个字符。

这样换行的小屏阅读体验更好,还便于在大屏显示器上并排阅读多个代码文件。““用一个‘\’来分割””

用空行分隔函数和类,及函数内较大的代码块。

最好把注释放到单独一行。

使用文档字符串。

运算符前后、逗号后要用空格,但不要直接在括号内使用: a = f(1, 2) + g(3, 4)。

赋值运算法 类和函数的命名要一致;按惯例,命名类用 UpperCamelCase,命名函数与方法用 lowercase_with_underscores。 命名方法中第一个参数总是用 self (类和方法详见 初探类)。

编写用于国际多语环境的代码时,不要用生僻的编码。Python 默认的 UTF-8 或纯 ASCII 可以胜任各种情况。

同理,就算多语阅读、维护代码的可能再小,也不要在标识符中使用非 ASCII 字符。

str_data = "srtyugoijpyugtfyrdtesrgffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff \ " \
           "fffffffffffffffffffffffffffffffffffffffffffffffffffffff"
def text_doc(x):
    """
     this is doc_string
    :param x:
    :return:
    """
    return None

print(text_doc.__doc__)  # 可以当做文档,方便阅读

Python代码规范通常遵循PEP 8(Python Enhancement Proposal 8)标准,下面是一些常见的Python代码规范: 1. 缩进:使用4个空格进行缩进,不要使用制表符。 2. 行长度:每行代码应尽量控制在79个字符以内,可以使用括号进行换行。 3. 空行:在函数和类定义之间、函数内的逻辑块之间使用空行进行分隔,以提高可读性。 4. 导入语句:每个导入语句应独占一行,按照标准库、第三方库和本地库的顺序进行分组。 5. 命名规范:变量名、函数名和模块名应使用小写字母,单词之间使用下划线进行分隔。类名应使用驼峰命名法。 6. 注释:使用注释来解释代码的功能、实现思路等。注释应该清晰、简洁,并且避免使用无意义的注释。 7. 函数和方法:函数和方法的命名应该清晰、简洁,并且能够准确描述其功能。函数和方法的参数应该有明确的命名,并且避免使用单个字符作为参数名。 8. 类:类的命名应该使用驼峰命名法,并且首字母大写。类应该有一个简洁明确的目的,并且遵循单一职责原则。 9. 异常处理:在可能发生异常的地方进行适当的异常处理,并且避免使用裸露的except语句。 10. 其他规范:避免使用全局变量,尽量使用局部变量;避免使用魔术数字,使用常量代替;避免使用复杂的表达式,尽量拆分为多个简单的表达式。 以上是一些常见的Python代码规范,遵循这些规范可以提高代码的可读性和可维护性。如果你还有其他问题,请继续提问。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值