分析一套源代码的代码规范和风格并讨论如何改进优化代码
我的工程实践课题是设计面向特定对象的搜索引擎。我在Github上找到了一套爬取今日头条、网易、腾讯新闻建立的简单搜索引擎。 目录结构、命名: 其目录如下图所示: 从目录结构来看,data主要存放数据库文件,web存放前端的一些内容。命名也算规范。 代码规范、风格: 截取其中一部分代码如下图: 可以看出, 代码基本上是符合python的编程规范的,例如变量名和函数名均是小写+下划线的形式进行,类名使用驼峰命名法。至于接口,这个项目比较简单,并没有传统意义上的接口,类之间也没有继承关系,方法都直接实现了。代码的风格良好,缩进与空行使用得当,命名也易于解读,代码整体简介明了,方便人的阅读。 列举违背代码一般原则,可以改进的地方: 以上图为例,在整体代码风格良好的情况下,缺少注释。注释是利于别人读懂代码的重要工具,没有注释很可能让别人甚至代码的作者后来都无法读懂代码,不利于代码交流以及后期代码的更正改进。另外,这套项目的目录结构混乱不够简洁,命名也不够明晰。 总结同类编程语言或项目在代码规范和风格的一般要求,总结如下: 一 代码编排 1 缩进。4个空格的缩进(编辑器都可以完成此功能), 不要使用Tap,更不能混合使用Tap和空格。 2 每行最大长度79,换行可以使用反斜杠,最好使用圆括号。换行点要在操作符的后边敲回车。 3 类和top-level函数定义之间 空两行;类中的方法定义之间