Автор оригинала: Team Python Pool.
Комментарии Python – Создание Удобного Для Пользователя Кода
Кодирование – это нелегко, и сделать этот код легким для понимания-само по себе большая проблема. Но комментарии python делают эту трудную задачу довольно легкой. Комментарии Python – это не что иное, как простое описание того, о чем вы думали, когда писали этот фрагмент кода. В основном, каков ваш мыслительный процесс, какие понятия вы используете в очень точной манере. Но они не оказывают никакого влияния на логику кода, так как полностью игнорируются интерпретатором.
Очень хорошая практика-использовать комментарии на python или любом другом языке программирования. Они не только делают код более читабельным, но и помогают устранить ошибки в коде и улучшить код для более поздних стадий разработки.
Написание комментариев на Python
В Python мы можем писать однострочные комментарии и многострочные комментарии.
Однострочные комментарии Python
Добавление комментариев к вашему коду – это не ракетостроение. Для добавления однострочного комментария python нам просто нужно поставить перед ним”#”.
Например:
Многострочные комментарии Python
Существует два способа добавления многострочных комментариев в python.
- Добавьте “#” перед каждым комментарием python. Например-
2. Использование Docstrings для комментариев python
Зачем использовать комментарии в python?
- В основном проект разделен между разработчиками, и все они имеют разные задачи. Один разработчик создает определенную функцию, а другой-другую. Таким образом, комментарии python позволяют другим разработчикам очень легко понять код, в то время как они должны что-то делать с кодом, например, добавлять что-то к нему.
- Давайте возьмем примерный случай. Предположим, в компании один разработчик работает над кодом и не использует комментарии. После завершения этого конкретного проекта он покидает компанию, и нанимается какой-то другой разработчик. Через некоторое время клиент хочет внести некоторые изменения в проект, но разработчик, создавший код, уже покинул компанию, и ответственность за внесение изменений в код лежит на новом разработчике. Но поскольку предыдущий разработчик не написал комментариев о том, что было мышлением, стоящим за конкретным кодом, что будет делать конкретная функция, как кто-то новый узнает об этом и в конечном итоге потратит на это много времени. С другой стороны, если бы этот разработчик использовал комментарии в коде, новому разработчику было бы очень легко понять код и работать над ним.
Советы при использовании комментариев Python:
Написание хорошего комментария – это тоже искусство. Хороший разработчик всегда знает, как написать комментарий, который не является избыточным и точным, потому что написание каждой детали о функции только потеряет время. Это должно быть просто высокоуровневое представление о коде. А другой код следует сделать более читабельным, используя правильные имена переменных, правильные имена функций.
Иногда люди думают, что они единственные, кто будет читать код, так зачем же утруждать себя написанием комментария, но они не понимают, что только облегчат себе жизнь. Например, некоторые разработчики используют комментарии, используя их как href=”https://en.wikipedia.org/wiki/Pseudocode”>псевдокод и следить за тем, что осталось в программе. href=”https://en.wikipedia.org/wiki/Pseudocode”>псевдокод и следить за тем, что осталось в программе.
Почему? На этот вопрос следует ответить комментарием, а не что или как.
Многие хорошие программисты используют комментарии для процесса отладки. Разработчики комментируют фрагмент кода, который они не хотят использовать временно или найти ошибку.
Давайте рассмотрим пример того, как комментарии могут быть полезны при отладке или поиске ошибок в коде.
Здесь программа выдаст ошибку. И чтобы проверить ошибку, мы могли бы поместить комментарии к операторам if один за другим, а затем мы узнали бы, что ошибка вызвана a/b as и эта операция невозможна, и мы могли бы внести изменения в код в соответствии с этим.
Должен Читать:
- Как преобразовать строку в нижний регистр в
- Как вычислить Квадратный корень
- Пользовательский ввод | Функция ввода () | Ввод с клавиатуры
- Лучшая книга для изучения Python
Где комментировать:
Некоторые программисты всегда задают этот вопрос – куда девать комментарии? Ответ на этот вопрос заключается в том, чтобы поместить комментарии Python в следующие три места: –
- Комментарий заголовка– В нем должно быть указано имя создателя и цель программы.
- Python Function Comment: Этот комментарий должен описывать функцию и ее роль в программе.
- Встроенные комментарии: Когда мы используем нестандартную логику или концепцию, мы можем поместить комментарии так, чтобы потом их не забыть.
Ярлык для комментирования определенного фрагмента кода:
В некоторых Python IDE, таких как Jupyter Notebook и Pycharm, мы можем использовать ” Ctrl +/” для комментирования определенного фрагмента кода.
Вывод
Наконец, но не в последнюю очередь, при написании кода мы всегда должны иметь в виду, что человек, который собирается читать код, имеет очень ограниченные знания о языке программирования и создает комментарии python соответственно.