编程过程与规范

Posted on 2016-07-21 16:31  博雅塔之子  阅读(313)  评论(0编辑  收藏  举报

Python编程规范:程序模板

Python编程规范:注释

  • 好的注释解释为什么,而不是怎么样
  • 不要在注释中重复描述代码
  • 当自己在编写密密麻麻的注释来解释代码时,需要停下来看是否存在更大的问题
  • 想一想在注释中写什么,不要不动脑筋就输入
  • 写完注释之后要在代码的上下文中回顾一下,它们是否包含正确的信息?
  • 当修改代码时,维护代码周围的所有注释

Python编程规范:命名

  • Python库的命名约定有点混乱,因此很难使之变得完全一致,不过还是有公认的命名规范。
  • 新的模块和包(包括第三方的框架)必须符合这些标准,但对已有的库存在不同风格的,保持内部的一致性是首选的。

不要编写需要外部文档支持的代码,这样的代码是脆弱的,要确保你的代码本身读起来就很清晰。

编写自文档化的代码

  • 唯一能完整并正确地描述代码的文档是代码本身
  • 编写可以阅读的代码,其本身简单易懂

Python编程规范:语句

import 语句应遵循的原则:

    • import 次序:先 import Python 内置模块,再 import 第三方模块,最后 import 自己开发的项目中的其它模块;这几种模块中用空行分隔开来。
    • 一条 import 语句 import 一个模块。
    • 当从模块中 import 多个对象且超过一行时,使用如下断行法(py2.5以上版本):
      from module import (obj1, obj2, obj3, obj4, obj5, obj6)
    • 不要使用 from module import *,除非是 import 常量定义模块或其它你确保不会出现命名空间冲突的模块。