Apakah ada mekanisme untuk komentar blok besar Python code?
Sekarang, satu-satunya cara aku bisa melihat dari komentar keluar kode untuk memulai setiap baris dengan #
, atau untuk menyertakan kode di tiga kutipan: """
.
Masalah dengan ini adalah bahwa memasukkan #
sebelum setiap baris adalah rumit dan """
membuat string yang ingin saya gunakan sebagai komentar muncul dalam dokumentasi yang dihasilkan.
Setelah membaca semua komentar, jawabannya tampaknya menjadi "Tidak".
Python tidak memiliki mekanisme tersebut. Menambahkan awalan #
untuk setiap baris untuk memblokir komentar. Untuk informasi lebih lanjut, lihat PEP 8. Paling Python IDEs mendukung mekanisme untuk melakukan blok-komentar-dengan-pon-tanda-tanda secara otomatis untuk anda. Misalnya, di IDLE pada mesin saya, it's Alt+3 dan Alt+4.
Don't menggunakan triple-kutipan; seperti yang anda temukan, ini adalah untuk dokumentasi string tidak memblokir komentar, meskipun memiliki efek yang sama. Jika anda're hanya mengomentari hal-hal yang sementara, ini baik-baik saja sebagai tindakan sementara.
Satu-satunya cara anda dapat melakukan ini tanpa tiga tanda kutip untuk menambahkan:
if False:
Dan kemudian indent semua kode anda. Perhatikan bahwa kode ini masih perlu untuk memiliki sintaks yang tepat.
Banyak Python IDEs dapat menambahkan #
untuk anda pada setiap baris yang dipilih, dan menghapus mereka ketika un-komentar juga. Demikian juga, jika anda menggunakan vi atau Emacs anda dapat membuat macro untuk melakukan ini untuk anda untuk blok kode.
Setidaknya dalam VIM anda dapat memilih kolom pertama dari teks yang ingin anda masukkan dengan menggunakan Blok Visual mode (CTRL+V
di non-windows VIMs) dan kemudian menambahkan #
sebelum setiap baris menggunakan urutan ini:
I#<esc>
Di Blok Visual mode aku
bergerak ke mode insert dengan kursor sebelum blok pada baris pertama. Dimasukkan teks disalin sebelum setiap line di blok tersebut.
comm='''
Junk, or working code
that I need to comment.
'''
Anda dapat mengganti komunikasi
dengan variabel pilihan anda yang mungkin lebih pendek, mudah untuk touch-type, dan anda tahu tidak (dan tidak akan) terjadi pada program anda. Contoh: xxx
, oo
, null
, nihil
.
Ya, ada (tergantung pada editor). Di PyDev (dan di Aptana Studio dengan PyDev):
Pilih + 4 - komentar yang dipilih blok
Pilih + 5 - komentar yang dipilih blok
Di Visual Studio menggunakan Python Alat untuk Visual Studio, blok dapat berkomentar dengan Pilih+K, Pilih+C dan tanda komentar oleh Ctrl+K, Pilih+U.
Saya menggunakan Notepad++ pada mesin Windows, pilih kode anda, ketik CTRL-K
. Untuk komentar anda pilih kode dan tekan Pilih + Shift + K.
Kebetulan, Notepad++ bekerja dengan baik sebagai Python editor. Dengan auto-completion, code folding, sintaks, dan banyak lagi. Dan itu's gratis seperti dalam pidato dan seperti dalam bir!
Satu-satunya mekanisme untuk komentar kode Python (dipahami sebagai kode diabaikan oleh interpreter) adalah #.
Seperti yang anda katakan, anda juga dapat menggunakan string literal, yang tidak diabaikan oleh penafsir, tetapi dapat benar-benar relevan untuk pelaksanaan program.
Editor lain berbasis solusi: teks "persegi panjang" dalam Emacs.
Sorot kode yang anda ingin komentar, maka C-x-r-t #
Untuk un-komentar kode: sorot, maka C-x-r-k
Saya menggunakan ini sepanjang hari, setiap hari. (Ditugaskan untuk hot-kunci, tentu saja.)
Ini kuat dan regex pencarian/mengganti adalah alasan saya mentolerir Emacs's lainnya "eksentrik".
Menggunakan editor seperti SciTe, pilih kode anda, tekan Pilih + Q dan dilakukan.
Jika anda don't memiliki editor yang mendukung blok komentar anda dapat menggunakan triple dikutip string di awal dan akhir blok kode untuk 'efektif' komentar itu keluar. Hal ini tidak praktek terbaik sekalipun.