说说 Python 函数编写格式规范

版权声明:如果喜欢,就点个赞呗 O(∩_∩)O~ https://blog.csdn.net/deniro_li/article/details/88667317

  • 建议使用描述性名称来定义函数名。通过描述性名称,可以让我们很容易理解这个函数可以做什么。
  • 函数名只使用小写字母与下划线。
  • 函数需要包含可以简要阐述其功能的注释, 该注释以文档字符串格式定义,并且紧跟在函数定义之后。文档良好的函数让调用者只需要阅读文档字符串中的说明,就能够知道如何使用它。
  • 函数定义时,如果需要给形参指定默认值,那么等号两边没有空格。
  • 使用关键字实参调用参数时,等号两边没有空格。
  • 如果程序或模块包含多个函数, 那么可以使用两个空行将相邻的函数分开。这样可以更容易看出一个函数的起止位置。
  • 所有的 import 语句,都应该放在文件开头,程序级注释之后。

猜你喜欢

转载自blog.csdn.net/deniro_li/article/details/88667317