第55讲:Python为函数定义文档字符串

1.文档字符串的概念

对于函数、模块、类和方法,都会去定义一个文档字符串,所谓的文档字符串,就是定义一个帮助信息、解释说明,告诉使用者这个函数是做什么用的,文档字符串一般会位于函数体中的第一行,通常会用三个引号引起来。

之所以称为文档字符串,是因为可以使用工具根据在代码中定义的文档字符串,从而将某个函数的文档字符串打印出来。

作为合格的开发者,应该养成编写文档字符串的习惯,以提高程序的可读性。

函数中文档字符串的定义规则:

  • 在文档字符串的第一行,简洁主题,看到这个文档字符串就明白函数的作用和功能。
  • 文档字符串中第一行的首字母一般都要大写,第一行以句号结尾。
  • 如果文档字符串中包含多行,第二行一般都是空行,从第三行开始详细进行描述。

2.文档字符串的定义

查看某个函数的文档字符串,通过__doc__这个属性来查询。

print(sorted.__doc__

猜你喜欢

转载自blog.csdn.net/weixin_44953658/article/details/130999947