База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / Python

Коментари и документация

Знакът # извън низов литерал започва коментар до края на физическия ред.

Версия: Python 3.14; repository image, production runtime not attested

Синтаксис

# comment

def label():
    """Describe the result."""
    return '#tag'

Знакът # извън низов литерал започва коментар до края на физическия ред.

Анализаторът пропуска обикновените коментари. Начален низов литерал в тялото на функция може да даде документация чрез __doc__. В текстовата част на литерала # е знак. От 3.12 в израза на заместващо поле на f-низ # може да започне коментар до края на реда.

Функцията връща #tag, а документацията ѝ е Return a literal tag.

import ast
tree=ast.parse('def f():\n    """About f."""\n    # explanation\n    return "#"')
assert ast.get_docstring(tree.body[0])=='About f.'
assert len(tree.body[0].body)==2
assert ast.literal_eval(tree.body[0].body[-1].value)=='#'
text='f"""{1 # comment\n+2}"""'
assert eval(text)=='3'
assert '#tag'=='#'+'tag'

Примери

def label():
    """Return a literal tag."""
    # A comment cannot change the returned string.
    return "#tag"

print(label(), label.__doc__)

Резултат

#tag Return a literal tag.

Функцията връща #tag, а документацията ѝ е Return a literal tag.

Източници