前言
嗨嗨,大家好 ~ 继续接着上篇文章 ~
不好意思啦,时隔两天才更新
话不多说,马上开始 !
正文
注释
1、注释
1.1、块注释
“#”号后空一格,段落件用空行分开(同样需要“#”号)
1.2、行注释
至少使用两个空格和语句分开,注意不要使用无意义的注释
1.3、建议
在代码的关键部分(或比较复杂的地方), 能写注释的要尽量写注释
比较重要的注释段, 使用多个等号隔开, 可以更加醒目, 突出重要性
2、文档注释(Docstring)
作为文档的Docstring一般出现在模块头部、函数和类的头部,这样在python中可以通过对象的doc对象获取文档. 编辑器和IDE也可以根据Docstring给出自动提示.
- 文档注释以 “”" 开头和结尾, 首行不换行, 如有多行, 末行必需换行, 以下是Google的docstring风格示例
不要在文档注释复制函数定义原型, 而是具体描述其具体内容, 解释具体参数和返回值等
对函数参数、返回值等的说明采用numpy标准, 如下所示
文档注释不限于中英文, 但不要中英文混用
文档注释不是越长越好, 通常一两句话能把情况说清楚即可
模块、公有类、公有方法, 能写文档注释的, 应该尽量写文档注释
好啦,今天的分享到这里就结束了 ~
对文章有问题的,或者有其他关于python的问题,可以在评论区留言或者私信我哦
觉得我分享的文章不错的话,可以关注一下我,或者给文章点赞(/≧▽≦)/