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

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

 

 

 

 

按照每一个文件的主要功能进行命名，使得程序文件的做用清晰透明，便于读者把握脉络。

数据放置和前端程序各自放置在目录文件夹下，内容结构较为清晰

文件名命名为标准的驼峰式命名法

该源码最大的优势是使用了ini文件进行参数配置

 

 

 这样使得参数配置集中且方便修改。

 

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

引用部分的代码保留了相关转载声明。

 

 

 代码内变量名及函数名单词之间都用_分割，使得变量名清晰可读。

代码内注释较为详尽（主要是搬运的官方文档详尽，添加部分的问题仍是不小） 

函数头下方也会有函数变量注释

 

 

 以及符号附近均用空格隔开，方便阅读。

 

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

该套源码的注释及变量命名等没有明显的问题，可是整个程序的运行方式及环境配置方法均未作任何说明，且因为距离发布已通过去近两年的时间，tf框架及其余第三方包的的更新。须要至关的时间来进行debug，且调试到运行后仍没法运行出合适的结果，须要重构部分代码。

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

通常来讲最好有对应的文献来讲明具体的原理，源码以有明确的环境配置及运行流程为上。

配合适当的图解及必要的模块注释。