Apakah ada cara untuk membuat komentar multiline dengan Python?

Saya baru-baru ini mulai mempelajari Python , tetapi saya tidak dapat menemukan bagaimana menerapkan komentar multi-line. Sebagian besar bahasa memiliki simbol komentar blok seperti

/*

*/

Saya mencoba ini dengan Python, tetapi ada kesalahan, jadi ini mungkin bukan cara yang benar. Apakah Python sebenarnya memiliki fitur komentar multiline?

Anda dapat menggunakan string yang dikutip tiga kali lipat. Ketika mereka bukan docstring (hal pertama di kelas / fungsi / modul), mereka diabaikan.

'''
This is a multiline
comment.
'''

(Pastikan untuk membuat indentasi yang '''tepat untuk menghindari IndentationError.)

Guido van Rossum (pembuat Python) tweet ini sebagai "pro tip".

Namun, panduan gaya Python, PEP8, lebih suka menggunakan komentar satu baris berturut-turut , dan ini juga yang akan Anda temukan di banyak proyek. Editor teks biasanya memiliki jalan pintas untuk melakukan ini dengan mudah.

Python memang memiliki sintaksis string / komentar multiline dalam arti bahwa kecuali digunakan sebagai docstrings, string multiline tidak menghasilkan bytecode - seperti #halnya komentar yang terkait. Akibatnya, ia bertindak persis seperti komentar.

Di sisi lain, jika Anda mengatakan perilaku ini harus didokumentasikan dalam dokumentasi resmi untuk menjadi sintaks komentar yang benar, maka ya, Anda berhak mengatakan itu tidak dijamin sebagai bagian dari spesifikasi bahasa.

Dalam hal apa pun, editor teks Anda juga harus dapat dengan mudah mengomentari wilayah yang dipilih (dengan menempatkan a #di depan setiap baris secara individual). Jika tidak, beralihlah ke editor teks yang melakukannya.

Pemrograman dengan Python tanpa fitur pengeditan teks tertentu bisa menjadi pengalaman yang menyakitkan. Menemukan editor yang tepat (dan mengetahui cara menggunakannya) dapat membuat perbedaan besar dalam bagaimana pengalaman pemrograman Python dirasakan.

Editor teks tidak hanya dapat mengomentari daerah yang dipilih, tetapi juga harus dapat memindahkan blok kode ke kiri dan kanan dengan mudah, dan itu juga harus secara otomatis menempatkan kursor pada tingkat lekukan saat ini ketika Anda menekan Enter. Lipat kode juga bisa bermanfaat.

Untuk melindungi dari kerusakan tautan, berikut adalah isi tweet Guido van Rossum :

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

Dari jawaban yang diterima ...

Anda dapat menggunakan string yang dikutip tiga kali lipat. Ketika mereka bukan docstring (hal pertama di kelas / fungsi / modul), mereka diabaikan.

Ini tidak benar. Tidak seperti komentar, string triple-dikutip masih diuraikan dan harus valid secara sintaksis, terlepas dari mana mereka muncul dalam kode sumber.

Jika Anda mencoba menjalankan kode ini ...

def parse_token(token):
    """
    This function parses a token.
    TODO: write a decent docstring :-)
    """

    if token == '\\and':
        do_something()

    elif token == '\\or':
        do_something_else()

    elif token == '\\xor':
        '''
        Note that we still need to provide support for the deprecated
        token \xor. Hopefully we can drop support in libfoo 2.0.
        '''
        do_a_different_thing()

    else:
        raise ValueError

Anda akan mendapatkan ...

ValueError: invalid \x escape

... di Python 2.x atau ...

SyntaxError: (unicode error) 'unicodeescape' codec can't decode bytes in position 79-80: truncated \xXX escape

... di Python 3.x.

Satu-satunya cara untuk melakukan komentar multi-baris yang diabaikan oleh parser adalah ...

elif token == '\\xor':
    # Note that we still need to provide support for the deprecated
    # token \xor. Hopefully we can drop support in libfoo 2.0.
    do_a_different_thing()

Dalam Python 2.7, komentar multiline adalah:

"""
This is a
multilline comment
"""

Jika Anda berada di dalam kelas, Anda harus tab itu dengan benar.

Sebagai contoh:

class weather2():
   """
   def getStatus_code(self, url):
       world.url = url
       result = requests.get(url)
       return result.status_code
   """

AFAIK, Python tidak memiliki blokir komentar. Untuk mengomentari setiap baris, Anda dapat menggunakan #karakter.

Jika Anda menggunakan Notepad ++ , ada jalan pintas untuk memblokir komentar . Saya yakin orang lain seperti gVim dan Emacs memiliki fitur serupa.

Saya pikir tidak, kecuali bahwa string multiline tidak diproses. Namun, sebagian besar, jika tidak semua IDE Python memiliki shortkey untuk 'mengomentari' beberapa baris kode.

Jika Anda memberi komentar

"""
long comment here
"""

di tengah skrip, Python / linter tidak akan mengenalinya. Lipat akan kacau, karena komentar di atas bukan bagian dari rekomendasi standar. Lebih baik digunakan

# Long comment
# here.

Jika Anda menggunakan Vim , Anda bisa plugin seperti commentary.vim , untuk secara otomatis mengomentari garis panjang komentar dengan menekan Vjgcc. Di mana Vjmemilih dua baris kode, dan gccberkomentar keluar.

Jika Anda tidak ingin menggunakan plugin seperti di atas, Anda dapat menggunakan pencarian dan ganti like

:.,.+1s/^/# /g

Ini akan menggantikan karakter pertama pada baris saat ini dan selanjutnya dengan #.

Tidak ada fitur seperti komentar multi-baris. #adalah satu-satunya cara untuk mengomentari satu baris kode. Banyak dari Anda menjawab '' 'komentar' '' ini sebagai solusi mereka.

Tampaknya berfungsi, tetapi secara internal '''dengan Python mengambil garis-garis yang terlampir sebagai string biasa yang tidak diabaikan oleh interpreter seperti komentar menggunakan #.

Periksa dokumentasi resmi di sini

Sayangnya pengetatan tidak selalu dapat digunakan sebagai komentar! Jadi lebih aman untuk tetap berpegang pada standar setiap baris dengan #.

Berikut ini sebuah contoh:

test1 = [1, 2, 3, 4,]       # test1 contains 4 integers

test2 = [1, 2, '''3, 4,'''] # test2 contains 2 integers **and the string** '3, 4,'

Nah, Anda dapat mencoba ini (saat menjalankan kutipan, input ke pertanyaan pertama harus dikutip dengan '):

"""
print("What's your name? ")
myName = input()
print("It's nice to meet you " + myName)
print("Number of characters is ")
print(len(myName))
age = input("What's your age? ")
print("You will be " + str(int(age)+1) + " next year.")

"""
a = input()
print(a)
print(a*5)

Apapun yang terlampir di antara """akan dikomentari.

Jika Anda mencari komentar satu baris maka itu #.

Komentar multiline dengan Python:

Bagi saya, keduanya '' 'dan "" "berfungsi.

Contoh:

a = 10
b = 20
c = a+b
'''
print ('hello')
'''
print ('Addition is: ', a+b)

Contoh:

a = 10
b = 20
c = a+b
"""
print('hello')
"""
print('Addition is: ', a+b)

Komentar inline dalam Python dimulai dengan karakter hash.

hello = "Hello!" # This is an inline comment
print(hello)

Halo!

Perhatikan bahwa karakter hash dalam string literal hanyalah karakter hash.

dial = "Dial #100 to make an emergency call."
print(dial)

Tekan # 100 untuk melakukan panggilan darurat.

Karakter hash juga dapat digunakan untuk komentar baris tunggal atau ganda.

hello = "Hello"
world = "World"
# First print hello
# And print world
print(hello)
print(world)

Halo

Dunia

Lampirkan teks dengan tanda kutip ganda rangkap untuk mendukung docstring.

def say_hello(name):
    """
    This is docstring comment and
    it's support multi line.
    :param name it's your name
    :type name str
    """
    return "Hello " + name + '!'


print(say_hello("John"))

Halo John!

Lampirkan teks dengan tanda kutip tunggal tunggal untuk komentar blok.

'''
I don't care the parameters and
docstrings here.
'''

Pada Python 2.7.13:

Tunggal:

"A sample single line comment "

Multiline:

"""
A sample
multiline comment
on PyCharm
"""

Kode Visual Studio universal universal multi-line comment toggle.

macOS: Pilih blok-kode lalu ⌘+/

Windows: Pilih blok-kode lalu Ctrl+/

Ya, boleh saja menggunakan keduanya:

'''
Comments
'''

dan

"""
Comments
"""

Tapi, satu-satunya hal yang Anda semua perlu ingat ketika menjalankan dalam IDE, adalah Anda harus 'MENJALANKAN seluruh file agar dapat diterima sebagai beberapa kode baris. Baris demi baris 'RUN' tidak akan berfungsi dengan baik dan akan menampilkan kesalahan.

Untuk mengomentari banyak baris kode dalam Python adalah cukup menggunakan #komentar satu baris pada setiap baris:

# This is comment 1
# This is comment 2 
# This is comment 3

Untuk menulis komentar multi-baris "layak" dalam Python adalah dengan menggunakan string multi-line dengan """sintaksis Python memiliki fitur string dokumentasi (atau dokumen). Ini memberi programmer cara mudah menambahkan catatan cepat dengan setiap modul, fungsi, kelas, dan metode Python.

'''
This is
multiline
comment
'''

Juga, sebutkan bahwa Anda dapat mengakses docstring oleh objek kelas seperti ini

myobj.__doc__

Anda dapat menggunakan yang berikut ini. Ini disebut DockString.

def my_function(arg1):
    """
    Summary line.
    Extended description of function.
    Parameters:
    arg1 (int): Description of arg1
    Returns:
    int: Description of return value
    """
    return arg1

print my_function.__doc__

Saya akan menyarankan untuk tidak menggunakan """komentar multi-baris!

Berikut adalah contoh sederhana untuk menyoroti apa yang mungkin dianggap sebagai perilaku tak terduga:

print('{}\n{}'.format(
    'I am a string',
    """
    Some people consider me a
    multi-line comment, but
    """
    'clearly I am also a string'
    )
)

Sekarang lihat hasilnya:

I am a string

    Some people consider me a
    multi-line comment, but
    clearly I am also a string

String multi baris tidak diperlakukan sebagai komentar, tetapi digabungkan dengan 'clearly I'm also a string'untuk membentuk string tunggal.

Jika Anda ingin berkomentar banyak baris, lakukan sesuai dengan pedoman PEP 8 :

print('{}\n{}'.format(
    'I am a string',
    # Some people consider me a
    # multi-line comment, but
    'clearly I am also a string'
    )
)

Keluaran:

I am a string
clearly I am also a string

Menggunakan PyCharm IDE.

Anda dapat commentdan uncommentbaris kode menggunakan Ctrl + /. Ctrl + / komentar atau batalkan komentar pada baris saat ini atau beberapa baris yang dipilih dengan komentar baris tunggal ({# in Django templates, or # in Python scripts). Pressing Ctrl+Shift+/untuk blok kode sumber yang dipilih dalam template Django mengelilingi blok dengan {% comment %} and {% endcomment %}tag.

---

n = 5
while n > 0:
    n -= 1
    if n == 2:
        break
    print(n)

print("Loop ended.")

Pilih semua baris lalu tekan Ctrl + /

# n = 5
# while n > 0:
#     n -= 1
#     if n == 2:
#         break
#     print(n)

# print("Loop ended.")

Komentar multiline sebenarnya tidak ada di Python. Contoh di bawah ini terdiri dari string yang tidak ditetapkan, yang divalidasi oleh Python untuk kesalahan sintaksis.

Beberapa editor teks, seperti Notepad ++ , memberikan kami pintasan untuk mengomentari kode atau kata-kata tertulis.

def foo():
    "This is a doc string."
    # A single line comment
    """
       This
       is a multiline
       comment/String
    """
    """
    print "This is a sample foo function"
    print "This function has no arguments"
    """
    return True

Juga, Ctrl+ Kadalah jalan pintas di Notepad ++ untuk memblokir komentar. Itu menambahkan #di depan setiap baris di bawah pilihan. Ctrl+ Shift+ Kuntuk blok komentar.

Di antara jawaban lain, saya menemukan cara termudah adalah dengan menggunakan fungsi komentar IDE yang menggunakan dukungan komentar Python # .

Saya menggunakan Anaconda Spyder dan memiliki:

• Ctrl + 1 - Komentar / tanda komentar
• Ctrl + 4 - Komentari satu blok kode
• Ctrl+ 5- Batalkan komentar pada blok kode

Ini akan mengomentari / menghapus komentar satu baris / multi kode dengan # .

Saya merasa paling mudah.

Misalnya, blok komentar:

# =============================================================================
#     Sample Commented code in spyder
#  Hello, World!
# =============================================================================

Pilih baris yang ingin Anda komentari dan kemudian gunakan Ctrl+ ?untuk berkomentar atau batalkan komentar pada kode Python di editor Teks Sublime .

Untuk satu baris Anda dapat menggunakan Shift+ #.