打开APP
userphoto
未登录

开通VIP,畅享免费电子书等14项超值服

开通VIP
为了人身安全,你的Python要这样写

在使用Python的过程中,经常看Github上的代码,好的代码规范让人如沐春风。前些日子爆出的《美国程序员因为代码不规范,枪击四名同事》事件还让各只程序猿心有余悸。在学习深度学习的过程中,也愈发感觉到代码规范的重要性。看,坐我旁边的师兄写了一手极好的规范的代码,现在拿到了阿里的offer。让我们一起来学习下代码规范吧。

这里主要参考Google的Python代码规范,以及Python的PEP8代码规范。

**import: **

简单条件表达式

默认参数

String连接

文件操作

垂直对齐

函数注释

上面是小编截取的一段tensorflow的源码。对于函数的注释:

整个注释内容使用'''符号包围;

首先注明函数的作用;

Args: 列出参数的名字,并对其进行简略介绍,含义及类型等。如果接收便长的参数,也要进行说明。

Returns(对于生成器是Yields):描述返回值类型和含义,如果返回None,可以省略;

Raises:列出抛出的异常,没有可以省略;

有些简单的函数可以只使用'''注明其作用。

类注释

对于类注释,类似于函数注释:

整个注释内容使用'''符号包围;

首先注明类的作用,可以用更多对类的介绍;

Attributes:如果类有公共属性的话,需要类似于函数的Args的形式列出;

命 名

关于命名,推荐使用Python之父Guido推荐的规范:

最后期望大家和小编都能写一手规范的代码。

编辑:蜗壳小肥

本站仅提供存储服务,所有内容均由用户发布,如发现有害或侵权内容,请点击举报
打开APP,阅读全文并永久保存 查看更多类似文章
猜你喜欢
类似文章
【热】打开小程序,算一算2024你的财运
PEP 8
python部分常用命令
PEP8中文翻译(转)
PEP 8 - Python代码样式指南
Google内部Python代码风格指南(中文版)
IDA历年(2013-2009)插件大赛作品目录1
更多类似文章 >>
生活服务
热点新闻
分享 收藏 导长图 关注 下载文章
绑定账号成功
后续可登录账号畅享VIP特权!
如果VIP功能使用有故障,
可点击这里联系客服!

联系客服