该套源代码是实现音频解析分离的系统,使用的编程语言是 Python 。
如下图所示,源代码目录结构层次清晰,各文件夹的命名均使用了完整的对应着实际功能的英文单词,文件名符合文件内容,相关内容做到合理的归类,所以可以一目了然地知道各个文件夹所存储文件的功能。
如下图所示,源代码中的类名使用”大写字母开头“的方式命名,函数名、变量名均使用“小写+下划线”的方式命名,宏名使用”全大写“的方式命名。
采用这种命名风格,符合代码规范的一般要求,易于理解。但命名中使用下划线“_”,虽然一定程度上会使英文单词之间的界限清晰,但破坏了整体性,当代码较为复杂的情况下,不仅降低了代码存储效率,还可能造成误操作,误认为是多个函数或变量。
在这里,我更推荐使用驼峰式命名:
大驼峰:类名。
小驼峰:方法名,变量名,参数名。
全大写:常量名,单词之间下划线。
在该项目的代码编写中,符号和变量间隔合理,清晰整洁,符合基本的编写规范:
(1)运算符左右两边都加了空格;
(2)方法参数在定义和传入时,多个参数逗号后边都加了空格;
(3)左右小括号与括号内容之间没有出现空格;
(4)注释符与内容之间只有一个空格;
(5)每一行开始处的缩进使用的是Tab,没有使用空格;
从下图 run_command 函数可以看出,该函数定义了5个形参,但好在有3个形参设置了缺省默认值。在实际工作中,虽没有明确的规定,但为了易于函数的调用、测试的编写,函数应尽量避免三个以上的参数。
此外,这个项目中比较大的缺陷是注释较少,导致了可阅读性较差,理解起来非常不便。代码编写的通用规范建议,关键函数必须写上注释,说明函数的用途。
除上文提及到的一些代码规范的基本要求外,下面总结了一些编写风格的建议(非硬性要求):
原文:https://www.cnblogs.com/hmk0407/p/11664027.html