分析一套源代码的代码规范和风格并讨论如何改进优化代码

分析一套源代码的代码规范和风格并讨论如何改进优化代码

1、结合工程实践选题相关的一套源代码，根据其编程语言或项目特色，分析其在源代码目录结构、文件名/类名/函数名/变量名等命名、接口定义规范和单元测试组织形式等方面的作法和特色

我此次的工程实践是围绕密章检测展开的，须要用到与目标检测方面相关的知识，因而在github上找到了一套与此相关的代码。这套代码是基于python进行编程的，用到了pytorch框架和yolov3算法。

一、源代码目录结构

 

从图中能够看出，源码的目录结构简单清晰。

—assets/：存放原生资料文件，里面存放的是一些图片

—config/：主要存放一些项目配置文件和命令文件

—data/：存放数据，包括训练数据集和样本图片

—utils/：提供一些公共方法和辅助类方法的文件

—weights/：存放yolov3的配置文件和模型文件 

二、文件名/类名/函数名/变量名等命名

（1）文件名

detect.py：检测目标

models.py：神经网络模型

test.py：用来测试模型

train.py：用来训练模型

README.md：简要的描述该项目的信息，让使用者快速了解这个项目

requirements.txt：经过requirements.txt来管理依赖库

该项目中文件的命名仍是比较易读的，根据命名就能够大体了解这个文件主要是作什么的，实现了什么功能。同时经过README文件，使用者能够知道在使用该项目时，应该作哪些准备以及如何正确使用项目。

（2）类名、函数名和变量名

 

以Darknet类为例：这个类是nn.Module的子类，命名为Darknet，接着进行一些初始化，网络的前馈部分都是在foward的这个函数中完成的，pytorch会自动调用这个函数，首先，foward用来完成网络从输入到输出的pipline，其次，将输出的featuemap转换为更容易处理的形式。定义的forward函数如上所示，其包括三个参数，self，输入x，和targets。关于yolo算法的类、函数和变量名的定义，其实已经渐渐造成了默认的标准，该项目的代码也基本遵循了这些规范。

三、接口定义规范

该项目中并无明确地定义接口。实际上，python中无接口类型，定义接口只是一我的为规定，在编程过程自我约束，在python中接口由抽象类和抽象方法去实现，接口是不能被实例化的，只能被别的类继承去实现相应的功能。我的以为接口在python中并无那么重要，由于若是要继承接口，须要把其中的每一个方法所有实现，不然会报编译错误，还不如直接定义一个class，其中的方法实现所有为pass，让子类重写这些函数。固然若是有强制要求，必须全部的实现类都必须按照接口中的定义写的话，就必需要用接口。

广义上来讲，接口其实是定义一个规范、标准。不规范的代码和开发习惯使工做中的大部分时间都在定位问题+改代码，填堵遗留下来的坑，致使实际用于开发中的时间并很少，高质量、高效的代码，能够切实有效的提升工做效率，减小无谓的时间浪费。

四、单元测试组织形式

在目标检测相关算法中，最重要的就是目标检测的准确度，不只要对模型进行训练，还要对训练的结果进行准确度的测评。在该项目中，单独使用一个test.py文件对模型训练的结果进行测试。

 

2、列举哪些作法符合代码规范和风格通常要求

一、项目的目录结构较好地遵循了项目开发的目录规范，文件命名规范，一目了然。

二、代码编排：

 

（1）缩进采用4个空格而非tab；

（2）类和top-level函数定义之间空两行；类中的方法定义之间空一行

（3）每行不超过最大长度79

三、文档编排：

 

一句仅import一个库，采用from XX import XX引用库时避免了命名冲突

四、注释规范：

 

该项目中的注释风格比较统一，基本都是使用"""来包围注释内容。

 

行注释使用#。。。。

 

 

3、列举哪些作法有悖于“代码的简洁、清晰、无歧义”的基本原则，及如何进一步优化改进

一、模块、函数、类、方法的注释过于简洁，大部分函数基本没有注释，在读代码的时候比较费劲。

二、空行的做用就是隔离不一样函数类等，使井井有条。在本项目的代码中，不必的空行有点多

 

三、README.md文件只给了运行代码的方式，安装环境，启动命令以及运行的效果进行说明，并无对项目的结构、项目中的代码文件进行说明。

 

 

4、总结同类编程语言或项目在代码规范和风格的通常要求

项目目录规范：

经过规范化，可以更好的控制软件结构，让程序具备更高的可读性。

参考的目录结构：

 

个别说明：

README内容说明

1：软件定位，软件的基本功能

2：运行代码的方式：安装环境，启动命令等。

3：简要的使用说明。

4：代码目录结构说明，更详细能够说明软件的基本原理

5：常见问题说明。

requirements.txt

文件格式是一行包含一个包依赖的说明，要求这个格式能被pip识别，使用方式：

pip install -r requirements.txt 来安装全部依赖的包

以上各个目录模块如何动态导入，实现动态迁移。

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）块注释，在一段代码前增长的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。好比：

# Description : Module config.

# 

# Input : None

#

# Output : None

（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）类的属性（方法和变量）命名使用所有小写的方式，可使用下划线。

（10）类的属性有3种做用域public、non-public和subclass API，能够理解成C++中的public、private、protected，non-public属性前，前缀一条下划线。

（11）类的属性若与关键字名字冲突，后缀一下划线，尽可能不要使用缩略等其余方式。

（12）为避免与子类属性命名冲突，在类的一些属性前，前缀两条下划线。好比：类Foo中声明__a,访问时，只能经过Foo._Foo__a，避免歧义。若是子类也叫Foo，那就无能为力了。

（13）类的方法第一个参数必须是self，而静态方法第一个参数必须是cls。