被开除了?因为代码不规范?新人都注意一下!

Posted 鳌拜的表格熬夜

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了被开除了?因为代码不规范?新人都注意一下!相关的知识,希望对你有一定的参考价值。

事情是这样的:

昨天早上,我们部门的一个实习生被劝退(开除)了,导火索是因为他写的代码太烂了,不是说实现不了需求,而是这代码实在是太NM难看了,他师傅(我同事)找不着他人,亲自去调试想改一下代码,结果花了近3个小时也没调试出来。
.
估计这代码也就那个实习生自己看得懂,我也看了一下,真的是不堪入目,头皮发麻,最后我这个苦逼的同事只能自己去加班再写。
.
然后第二天实习生就被人事找去谈话,收拾东西走人了。

大家刚开始学习Python的时候,肯定被告诫过写代码一定要规范。但是很多人不以为然,觉得自己看得懂就好,又快捷又方便。

这个观点是错误的,实际上规范代码很重要。现在给大家说一下规范代码的好处吧:

1.提高代码的可读性,视觉感官上就明显好一些。
.
2.提高编码的效率,毕竟很多代码都是重复的,整齐的代码方便复制。
.
3.提高团队协作率,在工作中大家都是各司其职,清晰明了又统一的规范可以方便团队协同工作。

然后今天给大家分享一些Python代码编写时的规范吧!


一、命名

  1. 函数、变量及属性都应该用小写单词拼写,直接用_连接,不遵循驼峰命名法
  2. 类与异常应该首字母大写,不要用_连接
  3. 受保护的实例属性,应以单下划线开头
  4. 实例的私有属性,应以上下划线开头
  5. 模块级别的变量单词都要大写,中间以单下划线隔开
  6. 变量要尽可能有意义


二、空白

  1. 和语法相关的每一层缩进都用4个空格表示
  2. 赋值时等号两边都要有一个空格
  3. 每一行所占用的字符数应不超过79,实际操作中应当尽量不让代码编辑器的行滚动条显示出来
  4. 在使用函数进行函数式编程时,函数之间要空两行
  5. 在类中的函数,函数之间应该空一行
  6. 函数与类是同一个级别,则他们之间应该空两行
  7. 对于超出每行规定的字符数的长表达式,应当敲回车缩进,通常除了首行其余各行都要在原来的基础上再次缩进4个空格


三、语句

  1. 判断变量是否为None、False或True时不要用==,要用is,例如,if a is None
  2. import语句应放在句首,导入时要尽量使用绝对导入不要使用相对导入,并且导入时最好指定相应的模块的某一具体功能,例如,from datetime import datetime
  3. 模块导入时应根据标准库模块、第三方模块以及自用模块进行分类
  4. 检测容器不为空时,应使用if 容器名,例如,lists = [] if lists
  5. 采用内联形式的否定词,不要把否定词放在整个表达式的前面,例如,应该if a is not None 而不是 if not a is None

四、注释

  1. 对某些重要的代码块的功能说明,应使用单行注释
  2. 对整个模块功能的说明应使用多行注释
  3. 对类或函数的功能及使用方法的详细说明应使用文档字符串

五、并发

  1. I/O密集型,像web应用这样的场景应该使用多线程编程
  2. 计算密集型,像计算圆周率等场景应该使用多进程编程,尽可能利用多核CPU优势

以上是关于被开除了?因为代码不规范?新人都注意一下!的主要内容,如果未能解决你的问题,请参考以下文章

被开除了?因为代码不规范?新人都注意一下!

新人手册

程序员入职 6 天即被开除:项目丢了,新人背锅?

学校到职场新人的总结

就因一行代码,被开除

工程代码规范和更新规范