文章标题

来源:互联网 发布:如何查看淘宝等级 编辑:程序博客网 时间:2024/03/28 17:06

Python 代码风格学习

学习https://cs61a.org/articles/composition.html#control-structures 网站的记录。

代码风格指导原则

  1. 命名:要求表达函数或者变量的使用、目的和意义
  2. 函数:要求每个函数都可在整个程序中理想的完成单个功能。
  3. 目标:
    1. 保证每行代码都有存在的意义 。
    2. 删除无用的代码和注释。
    3. 旧版本的代码另存一个文档,只用来自己使用,而不是直接修改成新版本。
  4. 简洁:尽量通过函数减少程序主体的代码数量。

    命名变量
    1.变量名称使用描述性词语。
    2.数字符号和数字用缩略词或一个字母表示。
    3.避免使用‘o’和‘l’命名。这是为了避免和0和1混淆。
    4.不要创建非必要的变量;在表达式过长或者无明显含义时,生成变量。
    变量生成示例
    5.使用lower_case_and_underscore模式命名变量和函数。
    6.类名字首字母大写。
    感想:这些规则学编码之前都有遇到过,但没总结过,经过这样已整理,感觉清晰很多了。

空格和缩进

  1. 使用空格键进行缩进。python代码中缩进影响了代码的运行主体。一般编辑器默认空格键是一个缩进符。
  2. 限制一行的代码在80个字母之内。当出现超过80个字母的代码时,要考虑该情况是否过于复杂。
  3. 不要在代码之间插入空行。
  4. 使用tuple、lists或函数时,每个逗号之后加一个空格。
  5. 在函数、类的末尾和下一行之间插入一个空行。
  6. 不要在一行的末尾留下空白符。

    控制结构
    1.不要使用布尔变量(True 或者False)进行比较,如下图所示:
    布尔变量使用示例
    2.尽可能使用“隐性虚假值”。示例包括[],(),{},set()等空容器。
    隐性虚假值示例
    3.尽量使用is或者is not检查是否为空值,不使用==和!=
    4.遇到大量的if/else时:
    不要使用True/False
    当布尔表达式在末尾时
    尽量不要同时使用if和else
    if/else示例
    5.应当使用if时,不要使用while.
    6.不要使用带有条件语句的括号。

    注释

    1.三重引号技术上是字符串,而不是注释。
    2.Docstrings在函数或者类的开始,使用三重引号。

不要重复(DRY)
1.不要重复复杂的表达式:
DRY复杂表达式
这里感觉和命名变量里的不要创建非必要的变量相冲突。以后得视实际情况确定。
2.不要重复计算复杂的函数调用过程:
DRY复杂函数调用

生成器表达式
1.简洁的生成器是可以的,过于复杂的让人读不懂。
生成器表达式

整篇内容都是从网站上摘录下来的。看完后,感觉对python代码风格有了较清晰的认识。具体的,得以后自己慢慢摸索了。

原创粉丝点击