Найти в Дзене
Learning programming👾

Как ставить комментарии и зачем они нужны в Python

В этой статье вы узнаете: Комментарии в коде нужны, чтобы комментировать фрагменты кода и не запутаться в своём же коде. Если код большой и в нём много функций, то комментарии вообще необходимы! Также, если код большой (может это какой-то проект) то над ним работают целые команды из разных специалистов. И чтобы другим понимать ваш код, придётся вникать во всё, а это займёт время. Здесь и необходимы комментарии, с помощью которых другие специалисты будут легко и быстро понимать ваш код и ориентироваться по нему. Комментарии бывают: Всё, что находится в комментариях, Python игнорирует. и они никак не влияют на код. Они нужны только для удобства. Используйте комментарии обязательно, не ленитесь их ставить.
Оглавление

В этой статье вы узнаете:

  1. Зачем нужны комментарии
  2. Как комментировать

Зачем нужны комментарии

Комментарии в коде нужны, чтобы комментировать фрагменты кода и не запутаться в своём же коде. Если код большой и в нём много функций, то комментарии вообще необходимы!

Также, если код большой (может это какой-то проект) то над ним работают целые команды из разных специалистов. И чтобы другим понимать ваш код, придётся вникать во всё, а это займёт время. Здесь и необходимы комментарии, с помощью которых другие специалисты будут легко и быстро понимать ваш код и ориентироваться по нему.

Как комментировать

Комментарии бывают:

  • Однострочные. Комментарии, которые начинаются с символа «#». Используется для кратких пояснений к определённой строке кода.
  • Многострочные. Комментарии, которые позволяют описывать крупные части кода, например, целые функции или модули. В этом случаи ставятся тройные кавычки.
Комментарии в Python
Комментарии в Python

Всё, что находится в комментариях, Python игнорирует. и они никак не влияют на код. Они нужны только для удобства.

Используйте комментарии обязательно, не ленитесь их ставить.