1.6　注釋及文檔字符串

1.6.1　通過注釋為程序添加功能說明

和大部分腳本及UNIX-shell語言一樣，Python也使用#標示注釋。從#開始，直到該行結(jié)束的內(nèi)容，都是注釋。

被注釋的內(nèi)容，在程序功能方面沒有任何作用，但是良好的注釋習(xí)慣可以方便其他人了解你的程序功能，也方便自己在日后能讀懂曾經(jīng)寫過的代碼。

當然你也可以在測試代碼時，把一些不希望執(zhí)行的代碼先注釋掉，使其不發(fā)揮作用，而不是刪除它們。

小技巧：在PyCharm中，可以把要注釋的幾行選中，按組合鍵Ctrl + /。按組合鍵Ctrl + / 還可以把已經(jīng)注釋的內(nèi)容取消注釋。

1.6.2　使用文檔字符串添加幫助信息

在使用Linux操作系統(tǒng)時，如果想獲取幫助，可以執(zhí)行man命令。Python也提供了類似man的命令。在Python中，可以使用help（）函數(shù)獲取相關(guān)的幫助信息。例如，想獲取len（）內(nèi)部函數(shù)的使用方法，可以通過下面的方式實現(xiàn)：

查看幫助時，如果內(nèi)容過長，則可以通過按回車鍵或空格鍵來翻頁；如果想要退出幫助，則按小寫字母q鍵。

我們自己寫的程序也能實現(xiàn)這樣的功能，而且并不困難。下面舉的例子用到了函數(shù)，這里僅僅作為演示，如果不能理解，那就跳過這一部分，對知識理解不會有任何影響。

創(chuàng)建一個名為star.py的文件，輸入以下內(nèi)容：

在上面的示例中，用到了三引號（三個連續(xù)的雙引號，或者三個連續(xù)的單引號），三引號表達的意思和雙引號、單引號完全一樣，只不過它能夠保存輸入時的格式，如允許在引號內(nèi)輸入回車。如果在雙引號或單引號內(nèi)包含了多行，那么將會出現(xiàn)語法錯誤。注意，在star module下面有一個空行。

接下來，我們需要做的是，在交互解釋器中將star.py作為模塊導(dǎo)入（一個Python文件就是一個模塊文件，模塊名就是文件名，但是不包括.py）并查看幫助。如下所示：

三引號中的第一行出現(xiàn)在了NAME后面，其余行作為DESCRIPTION（描述）。pstar（）函數(shù)也有相關(guān)說明。

如果只想查看pstar（）函數(shù)的幫助，則可以這樣做：