Python PEP8 编码规范中文版

Posted 2020-11-08 点影

原文链接：https://legacy.python.org/dev/peps/pep-0008/

参考：https://blog.csdn.net/ratsniper/article/details/78954852

Code lay-out 代码布局

    Indentation 缩进
    Tabs or Spaces 制表符还是空格
    Maximum Line Length 行的最大长度
    Should a line break before or after a binary operator 在二元运算符之前应该换行吗
    Blank Lines 空行
    Source File Encoding 源文件编码
    Imports 导入
    Module level dunder names 模块级的呆名
    String Quotes 字符串引号

Whitespace in Expressions and Statements 表达式和语句中的空格

    Pet Peeves 不能忍受的事情
    Other Recommendations 其他建议

Comments 注释

    Block Comments 块注释
    Inline Comments 行内注释
    Documentation Strings 文档字符串

Naming Conventions 命名规范

    Overriding Principle 最重要的原则
    Descriptive Naming Styles 描述命名风格
    Prescriptive Naming Conventions 约定俗成命名约定
        Names to Avoid 应避免的名字
        Package and Module Names 包名和模块名
        Class Names 类名
        Exception Names 异常名
        Global Variable Names 全局变量名
        Function Names 函数名
        Function and method arguments 函数和方法参数
        Method Names and Instance Variables 方法名和实例变量
        Constants 常量
        Designing for inheritance 继承的设计
    Public and internal interfaces 公共和内部的接口

Programming Recommendations 编程建议

    Function Annotations 功能注释