首页 » 父与子的编程之旅:与小卡特一起学Python » 父与子的编程之旅:与小卡特一起学Python全文在线阅读

《父与子的编程之旅:与小卡特一起学Python》9.1 增加注释

关灯直达底部

注释是给你看的,而不是让计算机执行的。注释是程序文档的一部分,计算机运行程序时会忽略这些注释。

Python 中向程序增加注释有两种方法。

术语箱

文档(documentation)就是关于一个程序的信息,描述了程序并说明它是如何工作的。注释是程序文档的一部分,不过在代码本身以外,文档还包括其他部分,文档描述以下内容:

  • 为什么写这个程序(它的用途)

  • 这个程序是谁写的

  • 这个程序面向什么人(它的用户)

  • 如何组织

更大、更复杂的程序往往有更多文档。

第 6 章中提到的 Python 帮助就是一种文档。它的作用是帮助用户了解 Python 如何工作。