讀古今文學網 > 父與子的編程之旅:與小卡特一起學Python > 9.1 增加註釋 >

9.1 增加註釋

註釋是給你看的,而不是讓計算機執行的。註釋是程序文檔的一部分,計算機運行程序時會忽略這些註釋。

Python 中向程序增加註釋有兩種方法。

術語箱

文檔(documentation)就是關於一個程序的信息,描述了程序並說明它是如何工作的。註釋是程序文檔的一部分,不過在代碼本身以外,文檔還包括其他部分,文檔描述以下內容:

  • 為什麼寫這個程序(它的用途)

  • 這個程序是誰寫的

  • 這個程序面向什麼人(它的用戶)

  • 如何組織

更大、更複雜的程序往往有更多文檔。

第 6 章中提到的 Python 幫助就是一種文檔。它的作用是幫助用戶瞭解 Python 如何工作。