跳转至

4.3 数据类型基础——答疑:文档字符串

内容梗概

这是一段约两分钟的课堂答疑片段。有同学提问"注释怎么打,也是三个引号吗",老师借此机会澄清一个常见误解:写在函数开头的三引号字符串不是注释,而是**文档字符串**(docstring),并简要说明了它与注释的区别和用途,预告后面还会展开讲解。

知识点详解

文档字符串(docstring)

  • (约 00:00) 问题来源:同学把三引号当成了多行注释的写法,老师明确"打个叉"——这是文档字符串的概念。
  • (约 00:59) 它**不是注释**,但与注释类似:执行时这句话不会被显示出来,也不会产生任何操作。
  • (约 01:08) 与注释的关键区别:可以通过 f.__doc__ 这样的内置成员访问到这个字符串的内容(f 为函数名)。
  • (约 01:29) 用途:向其他开发者说明函数的功能。注释需要别人去读源代码才能看到;而文档字符串可以在写代码时通过 f.__doc__ 这样的语句直接把说明显示出来,不用翻源码。
  • (约 01:47) 老师预告:文档字符串后面还会展开讲,这里先点到为止。
  • (约 01:52) 答疑结束后转回正题,继续讲字符串的索引。

示例与演示

  • 本片段为概念答疑,无完整代码演示;核心示例即通过 函数名.__doc__ 访问函数开头三引号字符串的内容。

重点与难点

  • 三引号字符串放在函数开头时是**文档字符串**,不是注释;两者执行时都不产生操作,但文档字符串可被程序通过 __doc__ 读取,注释不能。
  • 文档字符串服务于"不写源码也能看函数说明"的协作场景。

关联内容

  • 依附于 4.2 字符串:三引号语法在 4.2 中刚讲完(用于多行字符串),本答疑澄清它的另一种用途。
  • 与 11.x 函数进阶与类章节关联:文档字符串的完整用法会在函数部分展开。