Python函数编写格式规范

作者: 烟雨丿丶蓝 | 来源:发表于2019-03-20 21:43 被阅读3次
image

建议使用描述性名称来定义函数名。通过描述性名称,可以让我们很容易理解这个函数可以做什么。

函数名只使用小写字母与下划线。

函数需要包含可以简要阐述其功能的注释, 该注释以文档字符串格式定义,并且紧跟在函数定义之后。文档良好的函数让调用者只需要阅读文档字符串中的说明,就能够知道如何使用它。

函数定义时,如果需要给形参指定默认值,那么等号两边没有空格。

使用关键字实参调用参数时,等号两边没有空格。

如果程序或模块包含多个函数, 那么可以使用两个空行将相邻的函数分开。这样可以更容易看出一个函数的起止位置。

所有的 import 语句,都应该放在文件开头,程序级注释之后。

相关文章

  • Python函数编写格式规范

    建议使用描述性名称来定义函数名。通过描述性名称,可以让我们很容易理解这个函数可以做什么。 函数名只使用小写字母与下...

  • 说说 Python 函数编写格式规范

    建议使用描述性名称来定义函数名。通过描述性名称,可以让我们很容易理解这个函数可以做什么。 函数名只使用小写字母与下...

  • macdown 格式编写规范

    标题 一级标题 二级标题 三级标题 四级标题 五级标题 粗体 加粗字体 斜体 斜体字体 斜体与加粗 斜体加粗字体 ...

  • Python编写规范

    一、代码编排 二、文档编排 三、空格 四、注释 五、文档描述 六、命名规范 七、Main:即使是一个打算被用作脚本...

  • python编写规范

    1. No getters and setters. Use @property and @x.setter in...

  • python编写规范

    一、 说明 为了规范Python代码的书写,提高代码的可读性,使编码人员在代码上更好的协作,制定了本规范。 中...

  • Python编写规范

    一、编码:Python 3 源码文件以UTF-8编码,所有字符串都是 unicode 字符串 二、标识符:我们自己...

  • 在IDEA中从零编写Python函数

    摘要: 处于业务需求,我们需要编写自定义的Python函数供其他程序调用的时候,可以用IDEA编写Python函数...

  • python学习笔记 - (2)函数

    定义函数格式:def 函数名(参数):代码1代码2... 调用函数格式:函数名(参数) /// python中,函...

  • format方法

    在python编程规范中,提出字符串格式化输出尽量用format函数而不是%。 主要包括以下几种: 1、直接用中括...

网友评论

    本文标题:Python函数编写格式规范

    本文链接:https://www.haomeiwen.com/subject/rtsxvqtx.html