Python'da çok satırlı yorumlar oluşturmanın bir yolu var mı?

Kısa süre önce Python okumaya başladım , ancak çok satırlı yorumların nasıl uygulanacağını bulamadım. Çoğu dilde aşağıdaki gibi blok yorum sembolleri bulunur:

/*

*/

Bunu Python'da denedim, ancak bir hata atıyor, bu yüzden bu muhtemelen doğru yol değil. Python'un aslında çok satırlı bir yorum özelliği var mı?

Üçlü tırnaklı dizeler kullanabilirsiniz. Bir öğretici olmadıklarında (bir sınıf / işlev / modüldeki ilk şey), yok sayılırlar.

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

(Biri '''önlemek için öncüyü uygun şekilde girintili tuttuğunuzdan emin olun IndentationError.)

Guido van Rossum (Python'un yaratıcısı) bunu bir "profesyonel ipucu" olarak tweetledi .

Ancak, Python'un stil rehberi PEP8, ardışık tek satırlık yorumları kullanmayı tercih ediyor ve birçok projede bulacağınız şey de bu. Metin editörlerinin genellikle bunu yapmak için bir kısayolu vardır.

Python bir var satırlı dize / yorum sözdizimi Docstringler olarak kullanılan sürece, o anlamda çok satırlı dizeleri hiçbir bayt kodu oluşturmak gibi - #-prepended yorumlarla. Aslında, bir yorum gibi davranır.

Öte yandan, bu davranışın gerçek bir yorum sözdizimi olması için resmi belgelerde belgelenmesi gerektiğini söylüyorsanız, evet, dil spesifikasyonunun bir parçası olarak garanti edilmediğini söylemek doğru olur.

Her durumda, metin düzenleyiciniz de seçilen bir bölgeyi kolayca yorumlayabilmelidir #(her satırın önüne birer birer ayrı ayrı yerleştirerek). Değilse, bunu yapan bir metin düzenleyicisine geçin.

Belirli metin düzenleme özellikleri olmadan Python'da programlama acı verici bir deneyim olabilir. Doğru editörü bulmak (ve nasıl kullanılacağını bilmek) Python programlama deneyiminin algılanmasında büyük bir fark yaratabilir.

Metin düzenleyici yalnızca seçilen bölgeleri yorumlayabilmeli, aynı zamanda kod bloklarını kolayca sola ve sağa kaydırabilmeli ve tuşuna bastığınızda imleci otomatik olarak mevcut girinti düzeyine getirmelidir Enter. Kod katlama da faydalı olabilir.

Bağlantı bozulmasına karşı korumak için Guido van Rossum'un tweet'inin içeriği :

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

Kabul edilen cevaptan ...

Üçlü tırnaklı dizeler kullanabilirsiniz. Bir öğretici olmadıklarında (bir sınıf / işlev / modüldeki ilk şey) yok sayılırlar.

Bu doğru değil. Yorumlardan farklı olarak, üç tırnaklı dizeler hala ayrıştırılır ve kaynak kodunda nerede göründüklerine bakılmaksızın sözdizimsel olarak geçerli olmalıdır.

Bu kodu çalıştırmayı denerseniz ...

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

Siz de ...

ValueError: invalid \x escape

... Python 2.x veya ...

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

... Python 3.x üzerinde.

Ayrıştırıcı tarafından dikkate alınmayan çok satırlı yorumlar yapmanın tek yolu ...

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()

Python 2.7'de çok satırlı yorum:

"""
This is a
multilline comment
"""

Bir sınıfın içindeyseniz, doğru şekilde sekmeniz gerekir.

Örneğin:

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

AFAIK, Python'un blok yorumları yok. Tek tek satırları yorumlamak için #karakteri kullanabilirsiniz .

Notepad ++ kullanıyorsanız , blok yorum yapmak için bir kısayol vardır . Eminim gVim ve Emacs gibi diğerleri benzer özelliklere sahiptir.

Bence, çok satırlı bir dize işlenmiyor. Ancak, tüm Python IDE'leri olmasa bile çoğunda birden fazla kod satırını 'yorumlamak' için bir kısayol tuşu bulunur.

Eğer bir yorum yaparsanız

"""
long comment here
"""

bir betiğin ortasında, Python / linters bunu tanımaz. Yukarıdaki yorum standart önerilerin bir parçası olmadığından katlama dağınık olacaktır. Kullanmak daha iyi

# Long comment
# here.

Vim kullanıyorsanız , uzun yorum satırlarını tuşuna basarak otomatik olarak yorumlamak için commentary.vim gibi eklentiler kullanabilirsiniz Vjgcc. Burada Vjiki kod satırı seçer ve gccyorumlar.

Yukarıdaki gibi eklentileri kullanmak istemiyorsanız, arama ve değiştirme yöntemlerini kullanabilirsiniz.

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

Bu, geçerli ve sonraki satırdaki ilk karakterin yerine geçer #.

Çok satırlı yorum diye bir özellik yoktur. #tek bir kod satırını yorumlamanın tek yoludur. Birçoğunuz bunu çözüm olarak `` bir yorum '' diye yanıtladı.

İşe yarıyor gibi görünüyor, ancak dahili '''olarak Python'da, yorumlayıcıyı kullanarak yorumun görmezden gelmediği normal bir dize olarak çevrelenen satırları alıyor #.

Burada resmi belgelere bakın

Ne yazık ki dize oluşturma her zaman yorum yapmak için kullanılamaz! Bu nedenle, her satırı a ile bekleyen standarda bağlı kalmak daha güvenlidir #.

İşte bir örnek:

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

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

Bunu deneyebilirsiniz (alıntılanan çalıştırıldığında, ilk sorunun girdisi alıntılanmalıdır '):

"""
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)

Aradaki """her şey yorumlanacaktır.

Tek satırlık yorumlar arıyorsanız, o zaman öyle #.

Python'da çok satırlı yorum:

Benim için hem '' '' ve '' '' çalıştı.

Misal:

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

Misal:

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

Python'daki satır içi yorumlar bir karma karakteriyle başlar.

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

Merhaba!

Bir dizgi değişmezindeki karma karakterin yalnızca karma karakter olduğunu unutmayın.

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

Acil bir arama yapmak için # 100 tuşlayın.

Bir hash karakteri tek veya birden çok satır yorumu için de kullanılabilir.

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

Merhaba

Dünya

Öğretiyi desteklemek için metni üçlü çift tırnak işaretleri içine alın.

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"))

Merhaba John!

Blok yorumları için metni üç tek tırnak içine alın.

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

Python 2.7.13'te:

Tek:

"A sample single line comment "

Çok satırlı:

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

Visual Studio Code evrensel resmi çok satırlı yorum açma / kapatma.

macOS: Kod bloğunu ve ardından ⌘+/

Windows: Kod bloğunu seçin ve ardından Ctrl+/

Evet, her ikisini de kullanmak iyidir:

'''
Comments
'''

ve

"""
Comments
"""

Ancak, bir IDE'de çalışırken hatırlamanız gereken tek şey, birden çok satır kodu olarak kabul edilmek için tüm dosyayı 'ÇALIŞTIRMAK'. Satır satır 'RUN' düzgün çalışmaz ve bir hata gösterir.

Python'da birden fazla kod #satırını yorumlamak için her satırda tek satırlık bir yorum kullanmak yeterlidir :

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

Python'da “uygun” çok satırlı yorumlar yazmak için Python'un """dokümantasyon dizeleri (veya docstrings) özelliğine sahip sözdizimi ile çok satırlı dizeler kullanmaktır . Programcılara her Python modülü, işlevi, sınıfı ve yöntemi ile hızlı notlar eklemenin kolay bir yolunu sunar.

'''
This is
multiline
comment
'''

Ayrıca, böyle bir sınıf nesnesiyle öğretiye erişebileceğinizi de belirtin

myobj.__doc__

Aşağıdakileri kullanabilirsiniz. Buna DockString denir.

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__

"""Çok satırlı yorumlar için kullanmaya karşı tavsiye ediyorum !

Beklenmedik bir davranış olarak kabul edilebilecek şeyleri vurgulamak için basit bir örnek:

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

Şimdi çıktıya bir göz atın:

I am a string

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

Çok satırlı dize yorum olarak değerlendirilmedi, ancak 'clearly I'm also a string'tek bir dize oluşturacak şekilde birleştirildi .

Birden fazla satıra yorum yapmak istiyorsanız, bunu PEP 8 yönergelerine göre yapın :

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

Çıktı:

I am a string
clearly I am also a string

PyCharm IDE kullanma.

Ctrl + / tuşlarını kullanarak kod satırları commentve yapabilirsiniz . Ctrl + / geçerli satırı veya seçili birkaç satırı tek satır yorumlu olarak yorumlar veya açıklamayı kaldırır . Django şablonundaki seçili bir kaynak kodu bloğu bloğu etiketlerle çevreler .uncomment({# in Django templates, or # in Python scripts)Pressing Ctrl+Shift+/{% comment %} and {% endcomment %}

---

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

print("Loop ended.")

Tüm satırları seçip tuşuna basın Ctrl + /

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

# print("Loop ended.")

Python'da çok satırlı bir yorum yoktur. Aşağıdaki örnek, sözdizimsel hatalar için Python tarafından onaylanan atanmamış bir dizeden oluşur.

Notepad ++ gibi birkaç metin düzenleyici, bize yazılı bir kod veya kelime parçasını yorumlamak için kısayollar sağlar.

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

Ayrıca, Ctrl+ KNot Defteri ++ 'da yorumu engellemek için bir kısayoldur. Seçimin #altındaki her satırın önüne bir a ekler . Ctrl+ Shift+ K, blok rahatsızlığı içindir.

Diğer cevapların yanı sıra, Python yorum desteğini kullanan IDE yorum fonksiyonlarını kullanmak için en kolay yol olduğunu düşünüyorum #.

Anaconda Spyder kullanıyorum ve var:

• Ctrl+ 1- Yorum / uncomment
• Ctrl+ 4- Bir kod bloğunu yorumlayın
• Ctrl+ 5- Kod bloğunu kaldır

Tek bir / çok satırlı / kodlu yorum / uncomment olur #.

Bunu en kolay buluyorum.

Örneğin, bir blok yorumu:

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

Yorum yapmak istediğiniz satırları seçin ve ardından Yüce Metin düzenleyicisindeki Python kodunu yorumlamak veya yorumunu kaldırmak için Ctrl+ ?kullanın .

Tek satır için Shift+ kullanabilirsiniz #.