分析一套经典风格迁移项目代码的代码规范和风格

因为要学习迁移学习相关的内容,所以关注了GitHub一个简洁的风格迁移项目,这个项目目录逻辑清晰,主次分明,节约了阅读者的时间。从目录命名来看,均采用小写字母加下划线的方式,同时名称清晰的反应出文件内容,易于理解。

 分析一套经典风格迁移项目代码的代码规范和风格_第1张图片

 

整个项目大致流程为通过style.prototxt文件中的分层信息进行迁移学习训练,最终形成caffemodel模型文件,之后就可以利用模型进行图片风格迁移了,效果很好。

分析一套经典风格迁移项目代码的代码规范和风格_第2张图片分析一套经典风格迁移项目代码的代码规范和风格_第3张图片

了解了整个项目的目录结构和运行流程之后,我们接下来看项目的代码规范:

分析一套经典风格迁移项目代码的代码规范和风格_第4张图片

 

本套代码十分简单,函数命名均采用小写英文单词加下划线的组合,清晰易懂,但是这是作者调用的系统函数,作者自己创建的变量名过于简单,不能直观的反应变量的意义。

其次,本套代码基本没有注释,不便于阅读。

总体看来,作为一个基于Caffe的小型迁移学习项目,其总体上便于理解,但是代码规范和风格不够清晰,根据经验和查阅相关资料,总结出了以下几点:

1、标识符应当直观且可以拼读,可望文知意,最好采用英文单词或其组合,便于记忆和阅读。切忌使用汉语拼音来命名。

2、标识符的长度应当符合“min-length && max-information”原则。

3、命名规则尽量与所采用的操作系统或开发工具的风格保持一致,例如本项目系统风格为采用小写加下划线进行命名。

4、应采用最方便快捷目录结构,命名清晰易懂

5、要遵循约定俗成的文件设置习惯,例如:bin下放可执行文件,用来启动服务;conf下放配置文件;log下放日志文件,用于排错;README用于项目说明,并放在显眼位置。

 

综上,项目代码的规范和风格应该引起足够的重视,在将来参与大型项目的开发中将受益匪浅。

 

你可能感兴趣的:(分析一套经典风格迁移项目代码的代码规范和风格)