Чи є спосіб створити багаторядні коментарі в Python?

Нещодавно я почав вивчати Python , але не міг знайти, як реалізувати багаторядкові коментарі. Більшість мов мають символи блоку коментарів, як

/*

*/

Я спробував це в Python, але це видає помилку, тому це, мабуть, не правильний спосіб. Чи дійсно в Python є функція багаторядкових коментарів?

Можна використовувати рядки з потрійним цитуванням. Коли вони не є docstring (перше, що в класі / функції / модулі), вони ігноруються.

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

(Обов’язково '''належним чином відзначте відступ, щоб уникнути IndentationError.)

Гвідо ван Россум (творець Python) твітнув це як "підказку".

Однак, керівництво стилем Python PEP8 надає перевагу використанню послідовних однорядкових коментарів , і це також те, що ви знайдете у багатьох проектах. Текстові редактори зазвичай мають ярлик, щоб зробити це легко.

У Python є синтаксис багаторядкових рядків / коментарів у тому сенсі, що, якщо вони не використовуються як docstrings, багаторядкові рядки не генерують# байтового коду - як і попередні коментарі. Насправді це діє саме як коментар.

З іншого боку, якщо ви говорите, що така поведінка повинна бути зафіксована в офіційній документації, щоб бути синтаксисом справжнього коментаря, то так, ви б правильно сказали, що це не гарантується як частина мовної специфікації.

У будь-якому випадку, ваш текстовий редактор повинен також легко коментувати вибраний регіон (розміщуючи #перед кожним рядком окремо). Якщо ні, перейдіть до текстового редактора, який це робить.

Програмування в Python без певних функцій редагування тексту може бути болючим досвідом. Пошук правильного редактора (і вміння ним користуватися) може істотно змінитись у сприйнятті досвіду програмування Python.

Мало того, що текстовий редактор повинен коментувати вибрані регіони, він також повинен легко переміщувати блоки коду вліво і вправо, і він повинен автоматично розміщувати курсор на поточному рівні відступу при натисканні Enter. Складання коду також може бути корисним.

Щоб захистити від розпаду посилань, ось вміст твіту Гідо ван Россума :

Порада @BSUCSClub Python: Ви можете використовувати багаторядкові рядки як багаторядкові коментарі. Якщо вони не використовуються як docstrings, вони не генерують код! :-)

З прийнятої відповіді ...

Можна використовувати рядки з потрійним цитуванням. Коли вони не є docstring (перше, що в класі / функції / модулі), вони ігноруються.

Це просто неправда. На відміну від коментарів, рядки з потрійним цитуванням все ще розбираються і повинні бути синтаксично дійсними, незалежно від місця їх появи у вихідному коді.

Якщо ви спробуєте запустити цей код ...

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

Ви отримаєте або ...

ValueError: invalid \x escape

... на Python 2.x або ...

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

... на Python 3.x.

Єдиний спосіб робити багаторядкові коментарі, які ігноруються парсером, це ...

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 багаторядковий коментар:

"""
This is a
multilline comment
"""

Якщо ви перебуваєте всередині класу, вам слід правильно його вкласти.

Наприклад:

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

AFAIK, Python не має коментарів до блоку. Для коментування окремих рядків ви можете використовувати #символ.

Якщо ви використовуєте Notepad ++ , є ярлик для блокування коментування . Я впевнений, що такі, як gVim та Emacs, мають подібні функції.

Я думаю, це не відбувається, за винятком того, що багаторядковий рядок не обробляється. Однак у більшості, якщо не у всіх ідентифікаторів Python є ярлик для «коментування» декількох рядків коду.

Якщо ви помістите коментар

"""
long comment here
"""

в середині сценарію Python / лінтери не розпізнають цього. Складання буде зіпсовано, оскільки вищевказаний коментар не є частиною стандартних рекомендацій. Краще використовувати

# Long comment
# here.

Якщо ви використовуєте Vim , ви можете плагіни, як comentar.vim , щоб автоматично коментувати довгі рядки коментарів, натискаючи Vjgcc. Де Vjвибирає два рядки коду та gccкоментує їх.

Якщо ви не хочете використовувати плагіни, як описано вище, ви можете використовувати пошук і замінити подібні

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

Це замінить перший символ у поточному та наступному рядку на #.

Немає такої функції, як багаторядковий коментар. #це єдиний спосіб коментувати один рядок коду. Багато з вас відповіли на це питання як коментар.

Це, здається, працює, але всередині '''Python внутрішні рядки приймають укладені рядки як звичайні рядки, які інтерпретатор не ігнорує, як використання коментарів #.

Ознайомтесь з офіційною документацією тут

На жаль, струфікацію не завжди можна використовувати як коментування! Тож безпечніше дотримуватися стандартних, попередньо перед кожним рядком знаків "a" #.

Ось приклад:

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

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

Ну, ви можете спробувати це (при запуску цитованих, вхід до першого питання слід цитувати '):

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

Що б там не було між """коментованим, буде прокоментовано.

Якщо ви шукаєте однорядкові коментарі, то це #.

Багаторядковий коментар у Python:

Для мене працювали і "", і "" ".

Приклад:

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

Приклад:

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

Вбудовані коментарі в Python починаються з хеш-символу.

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

Привіт!

Зауважте, що хеш-символ у рядковому літералі - це лише хеш-символ.

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

Наберіть номер 100, щоб здійснити екстрений виклик.

Хеш-символ також може використовуватися для коментарів в одній або декількох рядках.

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

Здравствуйте

Світ

Додайте текст за допомогою потрійних подвійних лапок, щоб підтримати 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"))

Привіт Джон!

Додайте текст за допомогою потрійних одиничних лапок для блокових коментарів.

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

На Python 2.7.13:

Одномісний:

"A sample single line comment "

Багаторядковий:

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

Універсальний офіційний багаторядковий перемикач коментарів Visual Studio Code .

macOS: виберіть код-код, а потім ⌘+/

Windows: Виберіть код-код, а потім Ctrl+/

Так, добре використовувати обидва:

'''
Comments
'''

і

"""
Comments
"""

Але, єдине, що вам потрібно пам’ятати, працюючи в IDE, це вам потрібно «РАБОТИ» весь файл, щоб прийняти його як кілька рядків. Рядок за рядком 'RUN' не працює належним чином, і з’явиться помилка.

Для коментування декількох рядків коду в Python - це просто використовувати #однорядковий коментар до кожного рядка:

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

Для написання «правильних» багаторядкових коментарів у Python є використання багаторядкових рядків із """синтаксисом Python має функцію рядків документації (або docstrings). Це дає програмістам простий спосіб додавання швидких приміток до кожного модуля, функції, класу та методу Python.

'''
This is
multiline
comment
'''

Також згадайте, що ви можете отримати доступ до docstring таким класовим об'єктом

myobj.__doc__

Можна скористатися наступним. Це називається 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__

Я б радив не використовувати """для багаторядкових коментарів!

Ось простий приклад, щоб виділити те, що можна вважати несподіваною поведінкою:

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

Тепер подивіться на вихід:

I am a string

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

Багаторядковий рядок не розглядався як коментар, але він 'clearly I'm also a string'об'єднувався з формуванням однієї рядка.

Якщо ви хочете коментувати кілька рядків, зробіть це відповідно до вказівок PEP 8 :

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

Вихід:

I am a string
clearly I am also a string

Використання PyCharm IDE.

Можна commentі uncommentрядки коду за допомогою Ctrl + /. Ctrl + / коментує або коментує поточний рядок або кілька вибраних рядків із коментарями в одній лінії ({# in Django templates, or # in Python scripts). Pressing Ctrl+Shift+/для вибраного блоку вихідного коду в шаблоні Django оточує блок {% comment %} and {% endcomment %}тегами.

---

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

print("Loop ended.")

Виберіть усі рядки, а потім натисніть Ctrl + /

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

# print("Loop ended.")

Багатоканальний коментар насправді не існує в Python. Наведений нижче приклад складається з непризначеного рядка, який підтверджений Python для синтаксичних помилок.

Кілька текстових редакторів, як-от Блокнот ++ , надають нам ярлики, щоб прокоментувати написаний фрагмент коду чи слова.

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

Також Ctrl+ K- це ярлик у Блокноті ++ для блокування коментарів. Він додає позначку #перед кожним рядком під виділенням. Ctrl+ Shift+ K- для блокування коментарів.

Серед інших відповідей я вважаю, що найпростішим способом є використання функцій коментарів IDE, які використовують підтримку коментарів Python #.

Я використовую Anaconda Spyder, і він має:

• Ctrl+ 1- коментар / коментар
• Ctrl+ 4- Прокоментуйте блок коду
• Ctrl+ 5- Відлучення блоку коду

Він буде коментувати / коментувати один / багато рядків коду #.

Мені це найлегше.

Наприклад, блоковий коментар:

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

Виберіть рядки, які ви хочете коментувати, а потім використовуйте Ctrl+, ?щоб коментувати або коментувати код Python в редакторі піднесеного тексту .

Для одного рядка ви можете використовувати Shift+ #.