个人工程实践课题是设计面向特定对象的搜索引擎。我在Github上找到了一套爬取今日头条、网易、腾讯新闻创建的简单搜索引擎。前端
其目录以下图所示:python
从目录结构来看,data主要存放数据库文件,web存放前端的一些内容。命名也算规范。web
截取其中一部分代码以下图:数据库
能够看出, 代码基本上是符合python的编程规范的,例如变量名和函数名均是小写+下划线的形式进行,类名使用驼峰命名法。至于接口,这个项目比较简单,并无传统意义上的接口,类之间也没有继承关系,方法都直接实现了。代码的风格良好,缩进与空行使用得当,命名也易于解读,代码总体简介明了,方便人的阅读。编程
以上图为例,在总体代码风格良好的状况下,缺乏注释。注释是利于别人读懂代码的重要工具,没有注释极可能让别人甚至代码的做者后来都没法读懂代码,不利于代码交流以及后期代码的更正改进。另外,这套项目的目录结构混乱不够简洁,命名也不够明晰。编程语言
一 代码编排编辑器
1 缩进。4个空格的缩进(编辑器均可以完成此功能),不要使用Tap,更不能混合使用Tap和空格。
2 每行最大长度79,换行可使用反斜杠,最好使用圆括号。换行点要在操做符的后边敲回车。
3 类和top-level函数定义之间空两行;类中的方法定义之间空一行;函数内逻辑无关段落之间空一行;其余地方尽可能不要再空行。函数
二 文档编排工具
1 模块内容的顺序:模块说明和docstring—import—globals&constants—其余定义。其中import部分,又按标准、三方和本身编写顺序依次排放,之间空一行。
2 不要在一句import中多个库,好比import os, sys不推荐。
3 若是采用from XX import XX引用库,能够省略‘module.’,都是可能出现命名冲突,这时就要采用import XX。搜索引擎
三 空格的使用
整体原则,避免没必要要的空格。
1 各类右括号前不要加空格。
2 逗号、冒号、分号前不要加空格。
3 函数的左括号前不要加空格。如Func(1)。
4 序列的左括号前不要加空格。如list[2]。
5 操做符左右各加一个空格,不要为了对齐增长空格。
6 函数默认参数的赋值符左右省略空格。
7 不要将多句语句写在同一行,尽管使用‘;’容许。
8 if/for/while语句中,即便执行语句只有一句,也必须另起一行。
四 注释
整体原则,错误的注释不如没有注释。因此当一段代码发生变化时,第一件事就是要修改注释!
注释必须使用英文,最好是完整的句子,首字母大写,句后要有结束符,结束符后跟两个空格,开始下一句。若是是短语,能够省略结束符。
1 块注释,在一段代码前增长的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。
2 行注释,在一句代码后加注释。好比:x = x + 1 # Increment x
可是这种方式尽可能少使用。
3 避免无谓的注释。
五 文档描述
1 为全部的共有模块、函数、类、方法写docstrings;非共有的没有必要,可是能够写注释(在def的下一行)。
2 若是docstring要换行,参考以下例子:
"""Return a foobang
Optional plotz says to frobnicate the bizbaz first.
"""
六 命名规范
整体原则,新编代码必须按下面命名风格进行,现有库的编码尽可能保持风格。
1 尽可能单独使用小写字母‘l’,大写字母‘O’等容易混淆的字母。
2 模块命名尽可能短小,使用所有小写的方式,可使用下划线。
3 包命名尽可能短小,使用所有小写的方式,不可使用下划线。
4 类的命名使用CapWords的方式,模块内部使用的类采用_CapWords的方式。
5 异常命名使用CapWords+Error后缀的方式。
6 全局变量尽可能只在模块内有效,相似C语言中的static。实现方法有两种,一是__all__机制;二是前缀一个下划线。
7 函数命名使用所有小写的方式,可使用下划线。
8 常量命名使用所有大写的方式,可使用下划线。
9 类的属性(方法和变量)命名使用所有小写的方式,可使用下划线。
9 类的属性有3种做用域public、non-public和subclass API,能够理解成C++中的public、private、protected,non-public属性前,前缀一条下划线。
11 类的属性若与关键字名字冲突,后缀一下划线,尽可能不要使用缩略等其余方式。
12 为避免与子类属性命名冲突,在类的一些属性前,前缀两条下划线。好比:类Foo中声明__a,访问时,只能经过Foo._Foo__a,避免歧义。若是子类也叫Foo,那就无能为力了。
13 类的方法第一个参数必须是self,而静态方法第一个参数必须是cls。