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

Posted 2021-03-26 weihong775

我的工程实践题目是：风格迁移应用开发和移植。以下分析是一套基于tensorflow的风格迁移代码。

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

该代码是利用python语言结构特点实现的风格迁移，其目录结构为：

 

其中程序文件有：settings.py; model.py; calculate_loss_function.py; train.py; read_data.py.

各文件的内容及功能如下：

settings.py：设定一些重要参数、文件路径以及迭代次数，相当于配置文件。

model.py：vgg19模型定义文件，内有各卷积层的计算公式及处理方法。

calculate_loss_function.py：计算损失函数，通过风格损失和内容损失以各自权重相加所得。

train.py：运行文件，调用模型计算卷积数据，利用损失函数不断迭代计算，优化参数。

read_data.py：读取文件并显示

 

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

个人觉得这套代码写的挺好的了，比我自己写的可读性强太多了，但其中还是有可以修改的地方。

再model.py中，可以加多一些模型的介绍，以及对self的说明，再读代码的过程中发现很多参数还是比较乱的，和一些函数的运行轨迹难以琢磨。

 

3、 总结同类编程语言或项目在代码规范和风格的一般要求。

Python编程语言的运用相对于c语言方便很多，起代码规范和风格一般要求总结如下：

①    简短，在python中重点就是做到整洁易读，因为python内本来就定义好了各种包和类，可以直接调用的形式让编程更加简单

②    命名规范化，变量命名以及函数别名都要讲究，以便增加其可读性并方便日后修改

③    熟练使用面向对象编程思想，编程操作的是对象而非过程。

④    采用模块化编程，不断精细模块，使得整个项目编程架构简明易读。