Cara untuk membuat multiline komentar di Python?
Saya baru mulai belajar Python, tapi saya tidak't menemukan cara untuk menerapkan multi-baris komentar. Kebanyakan bahasa memiliki blok komentar simbol-simbol seperti
/*
*/
Saya mencoba ini di Python, tapi melempar kesalahan, jadi ini mungkin bukan cara yang benar. Tidak Python benar-benar memiliki multiline fitur komentar?
1078
21
Anda dapat menggunakan double-quoted string. Ketika mereka're tidak docstring (hal pertama di kelas/fungsi/modul), mereka diabaikan.
(Pastikan untuk indent terkemuka
'''
tepat untuk menghindariIndentationError
.)Guido van Rossum (pencipta Python) tweeted ini sebagai "pro tip".
Namun, Python's panduan gaya, PEP8, nikmat menggunakan berturut-turut single-baris komentar, dan ini juga adalah apa yang anda'll menemukan di banyak proyek. Editor biasanya memiliki cara pintas untuk melakukan ini dengan mudah.
Python memang memiliki multiline string/komentar sintaks dalam arti bahwa kecuali digunakan sebagai docstrings, string multiline tidak menghasilkan bytecode -- seperti
#
-ditambahkan komentar. Pada dasarnya, ia bertindak persis seperti komentar.Di sisi lain, jika anda mengatakan perilaku ini harus didokumentasikan secara resmi docs untuk menjadi benar komentar syntax, maka ya, anda akan benar untuk mengatakan itu tidak dijamin sebagai bagian dari spesifikasi bahasa.
Dalam kasus apapun editor anda juga harus dapat dengan mudah comment-out yang dipilih wilayah (dengan menempatkan
#
di depan setiap baris secara individual). Jika tidak, beralih ke seorang editor yang tidak.Pemrograman dengan Python tanpa teks tertentu fitur editing yang dapat menjadi menyakitkan pengalaman. Menemukan editor yang tepat (dan mengetahui bagaimana cara menggunakannya) dapat membuat besar perbedaan dalam bagaimana pemrograman Python pengalaman yang dirasakan.
Tidak hanya harus editor dapat komentar-keluar daerah yang dipilih, harus juga akan mampu menggeser blok kode ke kiri dan kanan dengan mudah, dan harus secara otomatis menempatkan kursor pada saat ini lekukan tingkat ketika anda tekan Masukkan. Kode lipat juga dapat berguna.
Untuk melindungi terhadap link pembusukan, berikut adalah isi dari Guido van Rossum's tweet:
Dari jawaban yang diterima...
Ini hanya tidak benar. Tidak seperti komentar, triple-string dikutip masih diurai dan harus sintaksis yang berlaku, terlepas dari mana mereka muncul dalam kode sumber.
Jika anda mencoba untuk menjalankan kode ini...
Anda'll mendapatkan baik...
...pada Python versi 2.x atau...
...pada Python 3.x.
Satu-satunya cara untuk melakukan multi-baris komentar yang diabaikan oleh parser...
Di Python 2.7 multiline komentar:
Dalam kasus anda berada di dalam kelas anda harus tab dengan benar.
Misalnya:
AFAIK, Python doesn't memiliki blok komentar. Untuk mengomentari setiap baris, anda dapat menggunakan karakter
#
.Jika anda menggunakan Notepad++, ada jalan pintas untuk memblokir komentar. I'm yakin orang lain seperti gVim dan Emacs memiliki fitur serupa.
Saya pikir itu doesn't, kecuali bahwa multiline string isn't diproses. Namun, sebagian besar, jika tidak semua Python IDEs memiliki shortkey untuk 'komentar keluar' beberapa baris kode.
Jika anda menempatkan komentar dalam
di tengah-tengah sebuah script python/linter tidak reccognize itu. Lipat akan menjadi kacau, seperti komentar di atas adalah bukan bagian dari rekomendasi standar. Lebih baik untuk menggunakan
Jika anda menggunakan
vim
, anda dapat plugin seperti https://github.com/tpope/vim-commentary, untuk secara otomatis komentar yang panjang baris komentar dengan menekanVjgcc
. Di manaVj
memilih 2 baris kode, dangcc
komentar mereka.Jika anda tidak ingin menggunakan plugin seperti di atas anda dapat menggunakan pencarian dan mengganti suka
:.,.+1s/^/# /g
.Ini akan mengganti karakter pertama pada saat ini dan baris berikutnya dengan
#
.Tidak ada fitur seperti multi-baris komentar. # ini satu-satunya cara untuk komentar satu baris kode. Banyak dari anda yang menjawab ''' komentar ''' ini sebagai solusi mereka. Meskipun tampaknya bekerja tetapi secara internal ''' di python mengambil garis tertutup seperti biasa string yang penerjemah tidak mengabaikan seperti komentar menggunakan #.
Periksa dokumentasi resmi di sini
Sayangnya stringification tidak selalu dapat digunakan sebagai komentar keluar! Sehingga lebih aman untuk tetap berpegang pada standar mengawali setiap baris dengan
#
.Berikut ini sebuah contoh:
Nah, anda dapat mencoba ini (ketika menjalankan dikutip, masukan untuk pertanyaan pertama harus dikutip dengan
'
):Apapun tertutup antara
"""
akan berkomentar.Jika anda mencari untuk satu baris komentar maka's
#
.Inline komentar di python dimulai dengan hash hash karakter.
Perhatikan bahwa hash karakter dalam sebuah string literal adalah salah hash karakter.
Hash karakter juga dapat digunakan untuk satu atau beberapa baris komentar.
Melampirkan teks dengan tiga tanda kutip ganda untuk mendukung docstring.
Melampirkan teks dengan tiga tanda kutip tunggal untuk memblokir komentar.
Multiline komentar di Python: Bagi saya, kedua ''' dan """ bekerja
Ex:
Ex:
Pada Python 2.7.13:
Single:
Multiline:
Ya, itu baik-baik saja untuk menggunakan kedua
''' Komentar '''
dan""" Komentar """
Tapi, satu-satunya hal yang harus kalian ingat saat berjalan di suatu IDE, anda harus 'RUN' seluruh file yang akan diterima sebagai beberapa baris kode. Baris demi baris 'RUN' tidak't bekerja dengan baik dan akan menunjukkan kesalahan.
Untuk komentar beberapa baris kode dalam Python adalah untuk hanya menggunakan
#
single-baris komentar pada setiap baris:Untuk tulisan "tepat" multi-baris komentar di Python adalah dengan menggunakan multi-line string dengan
"""
sintaks Python memiliki dokumentasi string (atau docstrings) fitur. Ini memberi programmer cara mudah menambahkan catatan cepat dengan setiap modul Python, fungsi, kelas, dan metode.Juga, menyebutkan bahwa anda dapat mengakses docstring dengan kelas objek seperti ini
Saya akan menyarankan untuk tidak menggunakan
"""
untuk multi baris komentar!Berikut ini adalah contoh sederhana untuk menyoroti apa yang mungkin dianggap sebagai perilaku yang tidak terduga:
python print('{}\n{}'.format( 'I am a string', """ Beberapa orang menganggap saya multi-line comment, tapi """ 'jelas saya juga string' ) )
sekarang lihat di output: ``bash Saya seorang stringBeberapa orang menganggap saya multi-line comment, tapi jelas saya juga string `
Jadi apa yang terjadi adalah bahwa multi-line string itu tidak diperlakukan sebagai komentar, tapi yang disambung dengan
'jelas saya'm juga string'` untuk membentuk sebuah string tunggal.Jika anda ingin komentar beberapa baris melakukannya menurut PEP8 pedoman: ``python print('{}\n{}'.format( 'I am a string',
Beberapa orang menganggap saya
multi-line comment, tapi
'jelas saya juga string' ) )
Output:
bash Saya seorang string jelas saya juga string ``Di antara jawaban yang lain, saya menemukan cara termudah adalah dengan menggunakan IDE komentar fungsi yang menggunakan python komentar dukungan #
Saya menggunakan Anaconda Spyder dan memiliki :-
Itu akan komentar/komentar tunggal/multi line/s dengan kode #.
Saya menemukan hal yang paling mudah.
Misalnya blok komentar
Menggunakan PyCharm IDE.
Pilih semua garis kemudian tekan Ctrl + /
Multiline komentar doesn't benar-benar ada di python. Di bawah ini contoh iklan yang belum ditetapkan string, yang divalidasi oleh Python untuk kesalahan sintaksis. Beberapa teks editor seperti NotePad++` menyediakan cara pintas untuk komentar tertulis potongan kode atau kata-kata
Juga, PILIH + K shortcut di
Notepad++
untuk memblokir komentar, ia menambahkan#
di depan setiap baris di bawah pilihan. PILIH + SHIFT+ K adalah untuk memblokir komentar.VS Kode universal resmi multi-line comment beralih.
macOS: Pilih kode-blok maka ⌘+/
Windows: Pilih kode-blok maka Pilih+/