Mengapa Python tidak memiliki komentar multiline?

OK, saya sadar bahwa string triple-quotes dapat berfungsi sebagai komentar multiline. Sebagai contoh,

"""Hello, I am a 
   multiline comment"""

dan

'''Hello, I am a 
   multiline comment'''

Tapi secara teknis ini adalah string, benar?

Saya sudah googled dan membaca panduan gaya Python, tetapi saya tidak dapat menemukan jawaban teknis mengapa tidak ada implementasi formal multiline, / * * / jenis komentar. Saya tidak punya masalah menggunakan tanda kutip tiga, tapi saya sedikit ingin tahu apa yang menyebabkan keputusan desain ini.

Saya ragu Anda akan mendapatkan jawaban yang lebih baik daripada, "Guido tidak merasa perlu komentar multi-baris".

Guido telah tweet tentang ini:

Tip Python: Anda dapat menggunakan string multi-line sebagai komentar multi-line. Kecuali digunakan sebagai dokumen, mereka tidak menghasilkan kode! :-)

Komentar multi-baris mudah dipecahkan. Bagaimana jika Anda memiliki yang berikut dalam program kalkulator sederhana?

operation = ''
print("Pick an operation:  +-*/")
# Get user input here

Cobalah untuk berkomentar dengan komentar multi-baris:

/*
operation = ''
print("Pick an operation:  +-*/")
# Get user input here
*/

Ups, string Anda berisi pembatas komentar akhir.

Teks yang dikutip tiga kali lipat TIDAK boleh dianggap sebagai komentar multisaluran; dengan konvensi, mereka adalah dokumen . Mereka harus menjelaskan apa yang kode Anda lakukan dan bagaimana menggunakannya, tetapi tidak untuk hal-hal seperti mengomentari blok kode.

Menurut Guido, komentar multiline dengan Python hanyalah komentar baris tunggal yang bersebelahan (cari "blokir komentar").

Untuk mengomentari blok kode, saya terkadang menggunakan pola berikut:

if False:
    # A bunch of code

Ini kemungkinan kembali ke konsep inti bahwa harus ada satu cara yang jelas untuk melakukan tugas. Gaya komentar tambahan menambah komplikasi yang tidak perlu dan dapat mengurangi keterbacaan.

Nah, triple-quotes digunakan sebagai komentar multiline dalam dokumen. Dan # komentar digunakan sebagai komentar sebaris dan orang-orang terbiasa dengannya.

Sebagian besar bahasa skrip juga tidak memiliki komentar multiline. Mungkin itu penyebabnya?

Lihat PEP 0008 , Komentar bagian

Dan lihat apakah editor Python Anda menawarkan beberapa cara pintas keyboard untuk memblokir komentar. Emacs mendukungnya, juga Eclipse, mungkin sebagian besar dari IDE yang layak melakukannya.

Dari The Zen of Python :

Harus ada satu - dan lebih disukai hanya satu - cara yang jelas untuk melakukannya.

Secara pribadi gaya komentar saya di katakan seperti Java

/*
 * My multi-line comment in Java
 */

Jadi memiliki komentar single-line saja bukan hal yang buruk jika gaya Anda khas untuk contoh sebelumnya karena sebagai perbandingan Anda akan memiliki

#
# My multi-line comment in Python
#

VB.NET juga merupakan bahasa dengan komentar hanya satu baris, dan secara pribadi saya merasa menjengkelkan karena komentar pada akhirnya tampak kurang menyukai komentar dan lebih seperti semacam kutipan

'
' This is a VB.NET example
'

Komentar single-line-only akhirnya memiliki lebih sedikit penggunaan karakter daripada komentar multi-line, dan lebih kecil kemungkinannya untuk diloloskan oleh beberapa karakter yang cerdik dalam pernyataan regex mungkin? Tapi aku cenderung setuju dengan Ned.

Untuk mengomentari blok kode di Pycharm IDE:

• Kode | Komentar dengan Komentar Baris
• Windows atau Linux: Ctrl+/
• OS Mac: Command+/

# This
# is
# a 
# multi-line
# comment

Gunakan blok komentar atau cari dan ganti (s / ^ / # / g) di editor Anda untuk mencapai ini.

Saya menyelesaikan ini dengan mengunduh makro untuk editor teks saya (TextPad) yang memungkinkan saya menyorot baris dan kemudian memasukkan # di bagian pertama dari setiap baris. Makro serupa menghapus # itu. Beberapa orang mungkin bertanya mengapa multiline diperlukan tetapi itu berguna ketika Anda mencoba untuk "mematikan" blok kode untuk keperluan debugging.

Untuk orang lain yang mencari komentar multi-baris dalam Python - menggunakan format triple quote dapat memiliki beberapa konsekuensi yang bermasalah, karena saya baru saja belajar dengan cara yang sulit. Pertimbangkan ini:

this_dict = {
    'name': 'Bob',

"""
This is a multiline comment in the middle of a dictionary
"""

    'species': 'Cat'
}

Komentar multi-baris akan dimasukkan ke string berikutnya, mengacaukan 'species'kunci. Lebih baik gunakan saja #untuk komentar.

Karena konvensi # adalah yang umum, dan benar-benar tidak ada yang dapat Anda lakukan dengan komentar multiline yang tidak dapat Anda lakukan dengan komentar # -sign. Ini kecelakaan historis, seperti nenek moyang dari /* ... */komentar yang kembali ke PL / I,

Anggap saja mereka dianggap tidak perlu. Karena sangat mudah untuk mengetik saja #a comment, komentar multiline dapat terdiri dari banyak komentar satu baris.

Untuk HTML , di sisi lain, ada lebih banyak kebutuhan untuk multiliners. Lebih sulit untuk terus mengetik <!--comments like this-->.

Ini hanya dugaan .. tapi

Karena mereka adalah string, mereka memiliki beberapa nilai semantik (kompiler tidak menghilangkannya), oleh karena itu masuk akal bagi mereka untuk digunakan sebagai dokumen. Mereka sebenarnya menjadi bagian dari AST , jadi mengekstraksi dokumentasi menjadi lebih mudah.

Selain itu, komentar multiline adalah menyebalkan . Maaf untuk mengatakan, tetapi terlepas dari bahasa, saya tidak menggunakannya untuk hal lain selain tujuan debugging. Katakanlah Anda memiliki kode seperti ini:

void someFunction()
{
    Something
    /*Some comments*/
    Something else
}

Kemudian Anda mengetahui bahwa ada sesuatu dalam kode Anda yang tidak dapat Anda perbaiki dengan debugger, jadi Anda mulai secara manual mendebugnya dengan mengomentari potongan kode yang lebih kecil dan lebih kecil dengan komentar multiline ini. Ini kemudian akan memberikan fungsi:

void someFunction()
{ /*
    Something
   /* Comments */
   Something more*/
}

Ini sangat menjengkelkan.

Komentar multiline menggunakan IDLE di:

• Mac OS X , setelah pemilihan kode, beri komentar satu blok kode dengan Ctrl+ 3dan batalkan komentar menggunakan Ctrl+ 4.

• Windows , setelah pemilihan kode, beri komentar satu blok kode dengan Ctrl+ Alt+ 3dan batalkan komentar menggunakan Ctrl+ At+ 4.

Saya ingat pernah membaca tentang seorang pria yang akan memberikan komentar multi-barisnya ke dalam variabel yang dikutip tiga kali lipat:

x = '''
This is my
super-long mega-comment.
Wow there are a lot of lines
going on here!
'''

Ini memang memakan sedikit memori, tetapi memberi Anda fungsi komentar multi-line, dan ditambah kebanyakan editor akan menyoroti sintaks untuk Anda :)

Juga mudah untuk berkomentar kode hanya dengan membungkusnya dengan

x = '''

dan

'''