跳转至

编程过程与规范

高质量的代码不只是运行正确的,还要求可读性强和简洁高效。因此,编程是一个复杂的迭代过程。

遵照编程规范,可以减少不必要的错误、增强可读性。

例如:google的编程规范

https://github.com/google/styleguide

Python编程中值得注意的地方

  • 被直接执行的文件建议增加
1
2
#!/usr/bin/env python3  
# _*_ coding: utf-8 _*_
  • 带有中文的文件要说明其编码
  • 模块导入放在文件顶部
  • 主功能创建main函数来执行
  • 加上对name的判断,程序在被导入时不会直接执行
  • 两种注释方式:# 和""":#为真正的注释,文档字符串说明包、模块、类、函数的用法,包括使用实例和单元测试
  • 注释不重复语句的语法含义,这么做并没有意义。好的注释应该解释为什么,而不是怎么样。维护代码的同时,也要做好代码的维护
  • pydoc 可以自动根据注释生成文档,当然需要代码的规范注释
  • 老旧代码不符合新的规范,可以允许其存在,在新的代码中不要再使用
  • python语句不需要在行尾加分号
  • 类名使用驼峰风格,首字母大写。
  • 变量名使用下划线风格
  • 先import内置模块,然后是第三方模块,最后是自己编写的模块
  • 不要使用 import *,容易导致命名冲突

模块化设计

将大程序拆分成小模块