Python PEP8 編碼規範 註釋

　　與代碼相矛盾的註釋比沒有註釋還糟，當代碼更改時，優先更新對應的註釋！ 
　　註釋應該是完整的句子。若是一個註釋是一個短語或句子，它的第一個單詞應該大寫，除非它是以小寫字母開頭的標識符(永遠不要改變標識符的大小寫！)。 
　　若是註釋很短，結尾的句號能夠省略。塊註釋通常由完整句子的一個或多個段落組成，而且每句話結束有個句號。 
　　在句尾結束的時候應該使用兩個空格。 
　　當用英文書寫時，遵循Strunk and White （譯註：《Strunk and White, The Elements of Style》）的書寫風格。 
　　在非英語國家的Python程序員，請使用英文寫註釋，除非你120%的確信你的代碼不會被使用其餘語言的人閱讀。

塊註釋

　　塊註釋一般適用於跟隨它們的某些（或所有）代碼，並縮進到與代碼相同的級別。塊註釋的每一行開頭使用一個#和一個空格（除非塊註釋內部縮進文本）。 
　　塊註釋內部的段落經過只有一個#的空行分隔。、

行內註釋

　　有節制地使用行內註釋。 
　　行內註釋是與代碼語句同行的註釋。行內註釋和代碼至少要有兩個空格分隔。註釋由#和一個空格開始。 
　　事實上，若是狀態明顯的話，行內註釋是沒必要要的，反而會分散注意力。好比說下面這樣就不須要：

x = x + 1                 # Increment x

但有時，這樣作頗有用：

x = x + 1                 # Compensate for border

文檔字符串 

• 要爲全部的公共模塊，函數，類以及方法編寫文檔說明。非公共的方法沒有必要，可是應該有一個描述方法具體做用的註釋。這個註釋應該在def那一行以後。
• PEP 257 描述了寫出好的文檔說明相關的約定。特別須要注意的是，多行文檔說明使用的結尾三引號應該自成一行，例如：

"""Return a foobang

Optional plotz says to frobnicate the bizbaz first.
"""

• 對於單行的文檔說明，尾部的三引號應該和文檔在同一行。