【Python基础】入门自学最强资料(二)不用再去各个网站找资料了

前言

嗨嗨,大家好 ~ 继续接着上篇文章 ~
不好意思啦,时隔两天才更新
话不多说,马上开始 !

请添加图片描述

正文

注释

1、注释

1.1、块注释

“#”号后空一格,段落件用空行分开(同样需要“#”号)

请添加图片描述

1.2、行注释

至少使用两个空格和语句分开,注意不要使用无意义的注释

请添加图片描述

1.3、建议

在代码的关键部分(或比较复杂的地方), 能写注释的要尽量写注释
比较重要的注释段, 使用多个等号隔开, 可以更加醒目, 突出重要性

在这里插入图片描述

2、文档注释(Docstring)

作为文档的Docstring一般出现在模块头部、函数和类的头部,这样在python中可以通过对象的doc对象获取文档. 编辑器和IDE也可以根据Docstring给出自动提示.

  • 文档注释以 “”" 开头和结尾, 首行不换行, 如有多行, 末行必需换行, 以下是Google的docstring风格示例

在这里插入图片描述

不要在文档注释复制函数定义原型, 而是具体描述其具体内容, 解释具体参数和返回值等

在这里插入图片描述

对函数参数、返回值等的说明采用numpy标准, 如下所示

在这里插入图片描述

文档注释不限于中英文, 但不要中英文混用
文档注释不是越长越好, 通常一两句话能把情况说清楚即可
模块、公有类、公有方法, 能写文档注释的, 应该尽量写文档注释

好啦,今天的分享到这里就结束了 ~
对文章有问题的,或者有其他关于python的问题,可以在评论区留言或者私信我哦
觉得我分享的文章不错的话,可以关注一下我,或者给文章点赞(/≧▽≦)/

请添加图片描述

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值