按照每个文件的主要功能进行命名,使得程序文件的作用清晰透明,便于读者把握脉络。
数据放置和前端程序各自放置在目录文件夹下,内容结构较为清晰
文件名命名为标准的驼峰式命名法
该源码最大的优点是使用了ini文件进行参数配置
这样使得参数配置集中且方便修改。
引用部分的代码保留了相关转载声明。
代码内变量名及函数名单词之间都用_分割,使得变量名清晰可读。
代码内注释较为详尽(主要是搬运的官方文档详尽,添加部分的问题还是不小)
函数头下方也会有函数变量注释
以及符号附近均用空格隔开,方便阅读。
该套源码的注释及变量命名等没有明显的问题,但是整个程序的运行方式及环境配置方法均未做任何说明,且由于距离发布已经过去近两年的时间,tf框架及其他第三方包的的更新。需要相当的时间来进行debug,且调试到运行后仍无法运行出合适的结果,需要重构部分代码。
一般来说最好有对应的文献来说明具体的原理,源码以有明确的环境配置及运行流程为上。
配合适当的图解及必要的模块注释。
原文:https://www.cnblogs.com/bzgeng/p/11666649.html