關於編程語言中的註釋，其重要性基本上已為大家所共識。 然而關於註釋的規範，這個話題就像我們之前聊過的縮進、終止符和命名方式一樣，眾口難調。 註釋符通常可分為兩種，即行註釋與塊註釋（inline/block），它們在不同的編程語言中的符號可謂讓人眼花繚亂。 比如行註釋符，它至少有以下的 17 種之多（ ...
關於編程語言中的註釋，其重要性基本上已為大家所共識。
然而關於註釋的規範，這個話題就像我們之前聊過的縮進、終止符和命名方式一樣，眾口難調。
註釋符通常可分為兩種，即行註釋與塊註釋（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 的註釋符用法，大家是怎麼想的呢？歡迎留言交流。
如果你覺得本文分析得不錯，那你應該會喜歡這些文章：
4、Python 為什麼沒有 main 函數？為什麼我不推薦寫 main 函數？
6、Python 為什麼不支持 i++ 自增語法，不提供 ++ 操作符？
7、Python 為什麼只需一條語句“a,b=b,a”，就能直接交換兩個變數？
寫在最後：本文屬於“Python為什麼”系列（Python貓出品），該系列主要關註 Python 的語法、設計和發展等話題，以一個個“為什麼”式的問題為切入點，試著展現 Python 的迷人魅力。若你有其它感興趣的話題，歡迎填在《Python的十萬個為什麼？ 》里的調查問卷中。部分話題會推出視頻版，請在 B 站收看，觀看地址：視頻地址
公眾號【Python貓】， 本號連載優質的系列文章，有Python為什麼系列、喵星哲學貓系列、Python進階系列、好書推薦系列、技術寫作、優質英文推薦與翻譯等等，歡迎關註哦。
