Python 注释

在 Python 中,注释行以 # 开头。

在代码中,注释是针对人类读者的消息。计算机在读取代码时,会忽略注释。另外可以利用注释快速调试部分代码。

Atom 编辑器注释的快捷键 Ctrl + /

文档字符串 docstrings

文档字符串是一种注释,用于解释函数的作用以及使用方式。

格式:

  • 位于函数头部下一行
  • 三个引号 """ 开始,并在最后(或另起一行)以三个引号 """ 结束
  • 第一行简要解释了函数的作用
  • 可以对函数的参数进行了解释(描述了每个参数的作用和类型);也可以对函数输出进行说明。

Copyright © 2025 Ben

Theme BlogiNote

Icons from Icônes