今天跟大家嘮嘮Python中的注釋。
關(guān)于編程語言中的注釋，其重要性基本上已為大家所共識。
然而關(guān)于注釋的規(guī)范，這個話題就像我們之前聊過的縮進(jìn)、終止符和命名方式一樣，眾口難調(diào)。
注釋符通?？煞譃閮煞N，即行注釋與塊注釋（inline/block），它們在不同的編程語言中的符號可謂讓人眼花繚亂。
比如行注釋符，它至少有以下的 17 種之多（出自維基百科）：
// 注釋符：ActionScript, C (C99), C++, C#, D, F#, Go, Java, JavaScript, Kotlin, Object Pascal (Delphi), Objective-C, PHP, Rust, Scala, SASS, Swift, Xojo
# 注釋符：Bourne shell and other UNIX shells, Cobra, Perl, Python, Ruby, Seed7, Windows PowerShell, PHP, R, Make, Maple, Elixir, Nim
那么，Python 為什么用“#”號作注釋符，而不是“//”呢？
這個問題恐怕沒辦法從解析的效率、符號的辨識度和輸入的便利性等方面回答，因為它們基本上沒有區(qū)別。
// 注釋符基本上被 C 語言家族所用
# 注釋符則基本上是被 Shell 和其它腳本語言所用
Python 在創(chuàng)造之初，從 C 和 Shell 語言中借鑒了不少東西，但它是一種腳本語言，因此在注釋符這個最為基礎(chǔ)的語言要素上，就偏向了腳本語言的傳統(tǒng)。
在某些“類腳本語言”中，比如 yaml、conf 和 ini 等格式的配置文件，它們大多也是采用腳本語言的“#”號作為注釋符。
所以，Python 行內(nèi)注釋符的選擇，大概可以歸結(jié)為一種歷史原因，即借鑒了 Shell 腳本語言的寫法。
相比于行注釋符的多樣，塊注釋符更加是讓人眼花繚亂：
大多數(shù)寫法是我從未見過的，有些甚至是難以忍受的，槽點(diǎn)太多！
在這份表格里，我們看不到 Python，因為從嚴(yán)格意義上講，Python 并沒有塊注釋符！
一般而言，我們在連續(xù)的每行內(nèi)容前面加“#”號，達(dá)到塊注釋的效果。塊注釋被看作是多個行注釋。
PEP-8 中是這么建議的：
Each line of a block comment starts with a
#and a single space (unless it is indented text inside the comment).
有人曾在 Twitter 上發(fā)問，為什么 Python 沒有塊注釋符？
Guido 回復(fù)稱，可以將多行字符串用作塊注釋：
Python 的多行字符串用三對單引號或雙引號表示，它還可以用作文檔字符串（即Documentation Strings，簡寫docstrings）。
但是，將它當(dāng)做多行注釋符使用，在語義上則有點(diǎn)怪怪的——它表示的是一段字符串，雖然沒有賦值給變量，不會生成代碼，但是它并非語義上的注釋。
由于腳本語言的特性，它允許我們寫一段“無根的字符串”，在語法上沒有問題，也沒有負(fù)作用（negative effects），但是，如果把它作為注釋使用，這就是一種副作用（side effects）了。
從這點(diǎn)上考慮，我雖然不反對有人把多行字符串寫法用作塊注釋，但是我會更推薦大家使用“#”號作注釋。
另外，對于無用的代碼，最好的做法就是直接刪除，如果后續(xù)發(fā)現(xiàn)有需要，再回退修改。詳細(xì)的多行注釋盡量放在文檔字符串中，這樣在核心代碼中就會很少出現(xiàn)多行注釋的情況了。
對于 Python 的注釋符用法，大家是怎么想的呢？歡迎留言交流。
作者：豌豆花下貓
聯(lián)系客服
