Как добавить текст с описанием кода в исходный файл Python?

Question

Когда вы пишете код на Python, как вы можете написать что-то рядом с ним, что объясняет, что делает код, но не влияет на код?

Answer 1

Я думаю, вы говорите о комментариях ?

Есть простые комментарии, которые начинаются с #:

return sys.stdin.readline()       # This is a comment

А также строки документов, которые документируют модули, классы, методы и функции:

def getline():
    """This is a docstring"""
    return sys.stdin.readline()

В отличие от многих других языков, в Python нет синтаксиса многострочных комментариев (хотя строки документации могут быть многострочными).

Answer 2

Вы имеете в виду комментарии? Используйте символ # перед вашим комментарием.

http://en.wikibooks.org/wiki/Python_Programming/Source_Documentation_and_Comments

# This is a comment
print("Hello comment!")

Answer 3

Написать комментарий? Комментарии Python начинаются с #.