2013-06-23 45 views
2

我知道兩種在python中留言的方法。一個使用""",另一個使用#。我知道第一個可以用來返回一個函數幫助作爲一個好處。但是,我應該什麼時候使用一個,何時使用另一個?還有,我該如何評論?我是否必須按Tab鍵並使用下面的命令排列第一行評論?還是必須從行首開始?正確評論python命令的方式

+2

http://www.python.org/dev/peps/pep-0008/#comments –

回答

8

沒有,只有one way of commenting, using #

註釋以井字符(#)不是一個字符串的一部分,並且在物理行的結尾結束開始。

三重報價,""",創建一個字符串對象,這恰好被用作文檔字符串時,它是一個函數,模塊或一類的第一行。三重引用在其他許多地方也很有用,但不應與評論混淆。您可以像使用其他任何字符串一樣使用三重引號字符串,具體優點是可以在源代碼中使用實際換行符,而不必使用\n轉義字符。

雖然可以被用來通過把它變成一個多行字符串,而不是禁用的代碼塊,你真的應該做到這一點。使用適當的源代碼控制,並簡單地刪除該塊,或者使用編輯器,通過替代插入#來讓您註釋掉整個塊。

如需實際意見,請使用#Python style guide (PEP 8)有些話要說什麼時候以及如何使用評論;它有這樣的縮進說:

塊註釋通常適用於一些(或全部)後面的代碼,並縮進到與該代碼相同的級別。塊註釋的每一行都以#和單個空格開頭(除非它在註釋內縮進文本)。