项目中的代码风格规范的必要性

在项目中使用相同的代码风格规范是很有必要的。通过实践,发现好处多多。

第一个好处便是代码风格的统一可以很好地提高代码的可读性。制定一个相同的代码风格,如直接选用Python的PEP8官方风格指南,严格遵守后可以得到美观又统一风格的项目代码,这在多人协作的开发中是很有必要的,每个人编写代码的习惯不一样,特别是有些喜欢用一些奇怪或新奇的写法,这样可读性很差。尤其是灵活的脚本语言Python、JS等,越是灵活越需要规范,代码更多是写给人看,而不是仅仅给机器跑而已。实际上Github上稍微正规的项目都有自己的项目代码规范,如果没有显式标注,那便是默认使用官方的风格指南。Python的PEP8规范很详细,作为语言本身重要的补充,规范是代码简洁美观的有力保障。

第二个好处是可以发现隐藏的bug。代码风格如果规范得好(像PEP8),是可以发现代码中潜藏的bug的,比如未定义的变量,定义了变量却没使用,变量覆盖等等,当代码量越来越大,况且单元测试不完善的时候,代码规范检查可以发现一些基础的不良写法,发现隐藏的bug。(还是那句话,人都是不可靠的,总会有疏忽)

第三个好处是可以稍微提高性能。比如定义的变量未使用,引入的模块未使用等,会造成额外的性能消耗和代码冗余,代码规范可以方便地检查出来。

代码规范的检查最好是做到自动化,最少也要配置快捷使用方式。可以使用flake8和autopep8等检查规范和自动格式化代码的工具,很多IDE和编辑器都可以配置插件和快捷使用方式。Python中最专业最强大的IDE当数Pycharm,可以配置「External Tools」,Sublime之类的编辑器也可以方便地配置插件。

即便有工具可以检查和格式化代码,但自己平时编写代码时最好还是按照规范来编写,第一工具并非万能,不能过分依赖;第二是按照规范来编写本来就是一个习惯问题,养成好习惯,也就离编写漂亮又优雅代码的目标不远了。

关于代码规范和如何编写漂亮的Python代码,之前的博客:

要串起来,边实践边总结,长期以往才能进步。如果过一段时间再去看之前的代码,如果觉得还可以写得更好,说明是进步了,如果没觉得有需要改进的地方,那么往往是有问题的。