Python'un neden çok satırlı yorumları yok?

Tamam, üçlü tırnak dizelerinin çok satırlı yorum olarak kullanılabileceğini biliyorum. Örneğin,

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

ve

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

Ama teknik olarak konuşmak gerekirse, bunlar ipler, değil mi?

Google'ı araştırdım ve Python stil kılavuzunu okudum, ancak neden çok satırlı, / * * / yorum türlerinin resmi bir uygulaması olmadığına dair teknik bir cevap bulamadım. Üçlü tırnak kullanmakta sorunum yok, ancak bu tasarım kararına neyin yol açtığı konusunda biraz meraklıyım.

"Guido çok satırlı yorumlara ihtiyaç duymadı" ifadesinden daha iyi bir yanıt alacağınızdan şüpheliyim.

Guido bunu tweetledi :

Python ipucu: Çok satırlı dizeleri çok satırlı yorumlar olarak kullanabilirsiniz. Öğreti olarak kullanılmadıkça kod üretmezler! :-)

Çok satırlı yorumlar kolayca kırılabilir. Basit bir hesap makinesinde aşağıdakilere sahipseniz ne olur?

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

Bunu çok satırlı bir yorumla yorumlamaya çalışın:

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

Hata! Dizeniz son yorum sınırlayıcıyı içeriyor.

Üç alıntı metin çok satırlı yorum olarak düşünülmemelidir; gelince , onlar doktrinler . Kodunuzun ne yaptığını ve nasıl kullanılacağını açıklamalılar, ancak kod bloklarını yorumlamak gibi şeyler için değil.

Guido'ya göre, Python'daki çok satırlı yorumlar sadece bitişik tek satırlık yorumlardır ("blok yorumları" için arama yapın).

Kod bloklarını yorumlamak için bazen aşağıdaki kalıbı kullanırım:

if False:
    # A bunch of code

Bu muhtemelen bir görev yapmanın bariz bir yolunun olması gerektiği temel kavramına dayanmaktadır. Ek yorum stilleri gereksiz komplikasyonlar ekler ve okunabilirliği azaltabilir.

Üçlü alıntılar docstrings'de çok satırlı yorum olarak kullanılır. Ve # yorum satır içi yorum olarak kullanılır ve insanlar bunu kullanır.

Komut dosyası dillerinin çoğunun çok satırlı yorumları da yoktur. Belki de nedeni budur?

Bkz. PEP 0008 , bölüm Yorumlar

Ve Python editörünüzün blok yorum yapmak için bazı klavye kısayolları sunup sunmadığına bakın. Emacs, Eclipse'nin yanı sıra, muhtemelen iyi IDE'lerin çoğunu destekliyor.

Gönderen Python Zen :

Bunu yapmanın tek ve tercihen tek bir yolu olmalı.

Şahsen Java'daki yorum tarzım şöyle

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

Dolayısıyla, stiliniz önceki örneğe özgü ise, tek satırlı yorumlara sahip olmak o kadar da kötü bir şey değildir, çünkü

#
# My multi-line comment in Python
#

VB.NET aynı zamanda sadece tek satır yorum yapan bir dildir ve kişisel olarak yorumların daha az beğenilen yorumlar ve daha fazla alıntıya benzemesi gibi rahatsız edici buluyorum

'
' This is a VB.NET example
'

Yalnızca tek satırlık yorumlar, çok satırlı yorumlardan daha az karakter kullanımına sahiptir ve belki de normal ifadede bazı tehlikeli karakterler tarafından kaçma olasılığı daha düşüktür? Ned ile de aynı fikirdeyim.

Pycharm IDE'deki bir kod bloğunu yorumlamak için :

• Kodu | Satır Yorumu ile yorum yapma
• Windows veya Linux: Ctrl+/
• Mac OS: Command+/

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

Bunu yapmak için yorum bloğunu kullanın veya düzenleyicinizde arama yapın ve değiştirin (s / ^ / # / g).

Bunu, metin düzenleyicim (TextPad) için satırları vurgulamama izin veren bir makro indirerek çözdüm ve daha sonra her satırın başına # ekler. Benzer bir makro # 's kaldırır. Bazıları neden birden fazla satırın gerekli olduğunu sorabilir ancak hata ayıklama amacıyla bir kod bloğunu "kapatmaya" çalıştığınızda kullanışlı olur.

Python'da çok satırlı yorum arayan herkes için - üçlü alıntı formatını kullanmak, zor yoldan yeni öğrendiğim gibi bazı sorunlu sonuçlara yol açabilir. Bunu düşün:

this_dict = {
    'name': 'Bob',

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

    'species': 'Cat'
}

Çok satırlı yorum, 'species'anahtarı karıştırarak bir sonraki dizeye yapıştırılacaktır . #Yorumlar için kullanmak daha iyidir.

Çünkü # kuralı yaygın bir konudur ve # işaretli bir yorumla yapamayacağınız çok satırlı bir yorumla gerçekten yapabileceğiniz hiçbir şey yoktur. /* ... */PL / I'e geri dönen yorumların soyları gibi tarihsel bir kaza ,

Sadece gereksiz görüldüğünü varsayın. Sadece yazmak çok kolay olduğu için #a comment, çok satırlı yorumlar sadece tek satırlık yorumlardan oluşabilir.

İçin HTML , diğer taraftan, multiliners için ihtiyaç fazlası var. Yazmaya devam etmek daha zor <!--comments like this-->.

Bu sadece bir tahmin .. ama

Dizeler oldukları için bazı semantik değerleri vardır (derleyici onlardan kurtulmaz), bu nedenle doktrin olarak kullanılmaları mantıklıdır. Onlar aslında bir parçası haline AST belgelerine ayıklanması kolay olur böylece.

Ayrıca, çok satırlı yorumlar bir orospu . Söylemek için üzgünüm, ancak dil ne olursa olsun, hata ayıklama amaçlarından başka bir şey için kullanmıyorum. Bunun gibi bir kodunuz olduğunu varsayalım:

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

Sonra kodunuzda hata ayıklayıcı ile düzeltemeyeceğiniz bir şey olduğunu öğrenirsiniz, bu nedenle bu çok satırlı yorumlarla daha küçük ve daha küçük kod yığınlarını yorumlayarak manuel olarak hata ayıklamaya başlarsınız. Bu daha sonra işlevi verecektir:

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

Bu gerçekten rahatsız edici.

IDLE kullanarak çok satırlı yorumlar :

• Mac OS X , kod seçiminden sonra, birlikte kod bloğu açıklama Ctrl+ 3ve yorumsuz kullanarak Ctrl+ 4.

• , Windows , kod seçiminden sonra, birlikte kod bloğu açıklama Ctrl+ Alt+ 3ve yorumsuz kullanarak Ctrl+ At+ 4.

Çok satırlı yorumlarını üç tırnaklı bir değişkene koyacak bir adamı okuduğumu hatırlıyorum:

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

Bu biraz bellek kaplıyor, ancak size çok satırlı yorum işlevselliği veriyor ve çoğu editör sözdizimini sizin için vurgulayacak :)

Kodu basitçe sararak yorum yapmak da kolaydır

x = '''

ve

'''