註釋內容用什麼來表示
文章來源： Python貓
作者：豌豆花下貓
關於程式語言中的註釋，其重要性基本上已為大家所共識。
然而關於註釋的規範，這個話題就像我們之前聊過的縮排、終止符和命名方式一樣，眾口難調。
註釋符通常可分為兩種，即行註釋與塊註釋（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 為什麼用“#”號作註釋符，而不是“//”呢？
這個問題恐怕沒辦法從解析的效率、符號的辨識度和輸入的便利性等方面回答，因為它們基本上沒有區別。
我沒有找到官方的解釋，但是從這些註釋符的陣營中，已經不難得出一個較為合理的解釋：
// 註釋符基本上被 C 語言家族所用
# 註釋符則基本上是被 Shell 和其它指令碼語言所用
Python 在創造之初，從 C 和 Shell 語言中借鑑了不少東西，但它是一種指令碼語言，因此在註釋符這個最為基礎的語言要素上，就偏向了指令碼語言的傳統。
在某些“類指令碼語言”中，比如 yaml、conf 和 ini 等格式的配置檔案，它們大多也是採用指令碼語言的“#”號作為註釋符。
所以，
Python 行內註釋符的選擇，大概可以歸結為一種歷史原因，即借鑑了 Shell 指令碼語言的寫法。
相比於行註釋符的多樣，塊註釋符更加是讓人眼花繚亂：
大多數寫法是我從未見過的，有些甚至是難以忍受的，槽點太多！
在這份表格裡，我們看不到 Python，因為從嚴格意義上講，
Python 並沒有塊註釋符！
一般而言，我們在連續的每行內容前面加“#”號，達到塊註釋的效果。塊註釋被看作是多個行註釋。
PEP-8 中是這麼建議的：
Each line of a block comment starts with a # and a single space （unless it is indented text inside the comment）。
有人曾在 Twitter 上發問，為什麼 Python 沒有塊註釋符？
Guido 回覆稱，可以將多行字串用作塊註釋：
Python 的多行字串用三對單引號或雙引號表示，它還可以用作文件字串（即Documentation Strings，簡寫docstrings）。
但是，將它當做多行註釋符使用，在語義上則有點怪怪的——它表示的是一段字串，雖然沒有賦值給變數，不會生成程式碼，但是它並非語義上的註釋。
由於指令碼語言的特性，它允許我們寫一段“無根的字串”，在語法上沒有問題，也沒有（negative effects），但是，如果把它作為註釋使用，這就是一種副作用（side effects）了。
從這點上考慮，我雖然不反對有人把多行字串寫法用作塊註釋，但是我會更推薦大家使用“#”號作註釋。
另外，對於無用的程式碼，最好的做法就是直接刪除，如果後續發現有需要，再回退修改。詳細的多行註釋儘量放在文件字串中，這樣在核心程式碼中就會很少出現多行註釋的情況了。
對於 Python 的註釋符用法，大家是怎麼想的呢？歡迎留言交流。
想了解更多精彩內容，快來關注CDA資料分析師