在使用Python的过程中,经常看Github上的代码,好的代码规范让人如沐春风。前些日子爆出的《美国程序员因为代码不规范,枪击四名同事》事件还让各只程序猿心有余悸。在学习深度学习的过程中,也愈发感觉到代码规范的重要性。看,坐我旁边的师兄写了一手极好的规范的代码,现在拿到了阿里的offer。让我们一起来学习下代码规范吧。
这里主要参考Google的Python代码规范,以及Python的PEP8代码规范。
**import: **
简单条件表达式
默认参数
String连接
文件操作
垂直对齐
函数注释
上面是小编截取的一段tensorflow的源码。对于函数的注释:
整个注释内容使用'''符号包围;
首先注明函数的作用;
Args: 列出参数的名字,并对其进行简略介绍,含义及类型等。如果接收便长的参数,也要进行说明。
Returns(对于生成器是Yields):描述返回值类型和含义,如果返回None,可以省略;
Raises:列出抛出的异常,没有可以省略;
有些简单的函数可以只使用'''注明其作用。
类注释
对于类注释,类似于函数注释:
整个注释内容使用'''符号包围;
首先注明类的作用,可以用更多对类的介绍;
Attributes:如果类有公共属性的话,需要类似于函数的Args的形式列出;
命 名
关于命名,推荐使用Python之父Guido推荐的规范:
最后期望大家和小编都能写一手规范的代码。
编辑:蜗壳小肥
联系客服