Аватар для supmener
87 / 95 / 15
Регистрация: 26.06.2013
Сообщений: 4,754

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

11.03.2023, 17:03. Показов 724. Ответов 8
Метки нет (Все метки)

Студворк — интернет-сервис помощи студентам
Такие кавычки - это тоже комментарии в коде?
Python
1
2
'Привет, мир'
"Это комментарий?"
Заметил, что такие строки не вызывают ошибок. Думал до сих пор, что комментировать можно только так:
#
Или так:
Python
1
2
3
"""
Текст
"""
0
Programming
Эксперт
39485 / 9562 / 3019
Регистрация: 12.04.2006
Сообщений: 41,671
Блог
11.03.2023, 17:03
Ответы с готовыми решениями:

Как комментировать слэшами?
Прошу подсказать, есть ли настройка или расширение, чтобы комментировать вот так //: name = input(str('Введите имя')) // Ввод имени ...

Как комментировать статью?
Здравствуйте люди, помогите разобраться.... У меня есть статья в базе, мне нужно сделать комментарии к статье, есть 3 таблицы: 1 - blog, 2...

Как комментировать код на PHP
Может задаю тупой вопрос. НО обыскала весь интернет и не могу понять как комментить код. Вот пробовала следующее: /* */, //. НЕ...

8
Просто Лис
Эксперт Python
 Аватар для Рыжий Лис
5973 / 3735 / 1099
Регистрация: 17.05.2012
Сообщений: 10,791
Записей в блоге: 9
11.03.2023, 17:11
Цитата Сообщение от supmener Посмотреть сообщение
'Привет, мир'
Не комментарий.
Цитата Сообщение от supmener Посмотреть сообщение
"Это комментарий?"
Не комментарий.
Цитата Сообщение от supmener Посмотреть сообщение
"""
Текст
"""
Не комментарий.

Цитата Сообщение от supmener Посмотреть сообщение
Думал до сих пор, что комментировать можно только так:
#
Правильно думаешь, комментарии в питоне только начинаются с решётки. Всё остальное - это литералы строк, а раз ты никуда их не присваиваешь, то это такая же ошибка как следующий код:

Python
1
2 + 42
Code
1
Statement seems to have no effect
0
 Аватар для supmener
87 / 95 / 15
Регистрация: 26.06.2013
Сообщений: 4,754
11.03.2023, 17:23  [ТС]
А почему VSC работает, не показывая ошибок? И такое поведение при изучении документации BeautifulSoup позволяет экономить время, так как там таким образом оформлены пояснения к коду и не надо переделывать в принты при запуске примеров и сохранении их в удобном виде.

Хм, читал, что с помощью """ оформляются многострочные комментарии и при использовании в ООП к ним можно получать доступ через doc (точный синтаксис записывал в конспект, если это именно про Пайтон было).
0
Просто Лис
Эксперт Python
 Аватар для Рыжий Лис
5973 / 3735 / 1099
Регистрация: 17.05.2012
Сообщений: 10,791
Записей в блоге: 9
11.03.2023, 17:27
Цитата Сообщение от supmener Посмотреть сообщение
""" оформляются многострочные комментарии
Нет.

Цитата Сообщение от supmener Посмотреть сообщение
при использовании в ООП к ним можно получать доступ через doc
Это doc-strings и они не только в ООП (классах).

Добавлено через 1 минуту
При doc-strings происходит неявное присваивание. Это всё ещё не комментарий.

Python
1
2
3
4
5
6
7
8
9
10
11
12
13
>>> def f():
...     """doc-strings"""
...     pass
... 
>>> f.__doc__
'doc-strings'
>>> def f2():
...     pass
... 
>>> f2.__doc__
>>> f2.__doc__ = 'doc-strings2'
>>> f2.__doc__
'doc-strings2'
Добавлено через 32 секунды
Цитата Сообщение от supmener Посмотреть сообщение
И такое поведение при изучении документации BeautifulSoup позволяет экономить время, так как там таким образом оформлены пояснения к коду и
Это doc-strings
2
 Аватар для supmener
87 / 95 / 15
Регистрация: 26.06.2013
Сообщений: 4,754
11.03.2023, 17:27  [ТС]
Цитата Сообщение от supmener Посмотреть сообщение
оформлены пояснения к коду
Вернее показан вывод в консоль.
0
Просто Лис
Эксперт Python
 Аватар для Рыжий Лис
5973 / 3735 / 1099
Регистрация: 17.05.2012
Сообщений: 10,791
Записей в блоге: 9
11.03.2023, 17:29
doc-strings удаляются при компиляции с оптимизацией, поэтому не предназначены для хранения какой-либо информации.

Добавлено через 1 минуту
Цитата Сообщение от supmener Посмотреть сообщение
Вернее показан вывод в консоль.
Это doctests https://docs.python.org/2/library/doctest.html

Всё ещё не комментарии.

Добавлено через 16 секунд
https://docs.python.org/3/library/doctest.html
1
 Аватар для supmener
87 / 95 / 15
Регистрация: 26.06.2013
Сообщений: 4,754
11.03.2023, 17:45  [ТС]
https://pypi.org/project/docformatter/
— docformatter
pypi.org/project/docformatter

Строки документации (docstrings) регулируются набором соглашений, описанных в PEP 257. Главное правило звучит так: «Всегда используйте тройные двойные кавычки вокруг строк документации» ("""triple double quotes"""). docformatter поможет автоматически расставить громоздкие конструкции из кавычек, а также соблюсти другие рекомендации.
https://vk.com/wall-84793390_13797
0
Просто Лис
Эксперт Python
 Аватар для Рыжий Лис
5973 / 3735 / 1099
Регистрация: 17.05.2012
Сообщений: 10,791
Записей в блоге: 9
11.03.2023, 17:56
Всё ещё не комментарии.
0
1712 / 579 / 76
Регистрация: 10.04.2009
Сообщений: 9,321
11.03.2023, 18:54
не знаю как в чистом пайтоне а в пайчарме всё что серого цвета=после решётки то и есть комментарий
всё остальное это придумки
4
Надоела реклама? Зарегистрируйтесь и она исчезнет полностью.
inter-admin
Эксперт
29715 / 6470 / 2152
Регистрация: 06.03.2009
Сообщений: 28,500
Блог
11.03.2023, 18:54
Помогаю со студенческими работами здесь

Как правильно комментировать код
Всем привет. Объясните, пожалуйста, как и что комментировать в коде, чтобы исходники были предельно ясными?

Как лучше комментировать код?
Здравствуйте. У меня есть вопросы по коментированию кода. 1. Какой язык лучше использовать для коментариев (русский или английский)? ...

Как правильно комментировать html код
Мне нужно дописать class(css) к ссылке <a href... Вообщем вот код: $tpl->set( '', "<a href=\"" . $full_link . "\">"...

Как удобно и быстро комментировать код
Итак, есть я знаю три способа закомментировать код на VB.NET: 1. ' (одинарная кавычка) 2. REM 3. CTRL+K, CTRL+C Но, если я...

Можно ли для C++ сделать подсвечивание скобок? Как комментировать код в C++?
Предположим есть блок у которого есть границы выглядит это так {блок}, когда ставишь курсор внутрь этих скобок загорается 2ая фигурная...


Искать еще темы с ответами

Или воспользуйтесь поиском по форуму:
9
Ответ Создать тему
Опции темы

Новые блоги и статьи
SDL3 для Web (WebAssembly): Подключение Box2D v3, физика и отрисовка коллайдеров
8Observer8 12.02.2026
Содержание блога Box2D - это библиотека для 2D физики для анимаций и игр. С её помощью можно определять были ли коллизии между конкретными объектами и вызывать обработчики событий столкновения. . . .
SDL3 для Web (WebAssembly): Загрузка PNG с прозрачным фоном с помощью SDL_LoadPNG (без SDL3_image)
8Observer8 11.02.2026
Содержание блога Библиотека SDL3 содержит встроенные инструменты для базовой работы с изображениями - без использования библиотеки SDL3_image. Пошагово создадим проект для загрузки изображения. . .
SDL3 для Web (WebAssembly): Загрузка PNG с прозрачным фоном с помощью SDL3_image
8Observer8 10.02.2026
Содержание блога Библиотека SDL3_image содержит инструменты для расширенной работы с изображениями. Пошагово создадим проект для загрузки изображения формата PNG с альфа-каналом (с прозрачным. . .
Установка Qt-версии Lazarus IDE в Debian Trixie Xfce
volvo 10.02.2026
В общем, достали меня глюки IDE Лазаруса, собранной с использованием набора виджетов Gtk2 (конкретно: если набирать текст в редакторе и вызвать подсказку через Ctrl+Space, то после закрытия окошка. . .
SDL3 для Web (WebAssembly): Работа со звуком через SDL3_mixer
8Observer8 08.02.2026
Содержание блога Пошагово создадим проект для загрузки звукового файла и воспроизведения звука с помощью библиотеки SDL3_mixer. Звук будет воспроизводиться по клику мышки по холсту на Desktop и по. . .
SDL3 для Web (WebAssembly): Основы отладки веб-приложений на SDL3 по USB и Wi-Fi, запущенных в браузере мобильных устройств
8Observer8 07.02.2026
Содержание блога Браузер Chrome имеет средства для отладки мобильных веб-приложений по USB. В этой пошаговой инструкции ограничимся работой с консолью. Вывод в консоль - это часть процесса. . .
SDL3 для Web (WebAssembly): Обработчик клика мыши в браузере ПК и касания экрана в браузере на мобильном устройстве
8Observer8 02.02.2026
Содержание блога Для начала пошагово создадим рабочий пример для подготовки к экспериментам в браузере ПК и в браузере мобильного устройства. Потом напишем обработчик клика мыши и обработчик. . .
Философия технологии
iceja 01.02.2026
На мой взгляд у человека в технических проектах остается роль генерального директора. Все остальное нейронки делают уже лучше человека. Они не могут нести предпринимательские риски, не могут. . .
КиберФорум - форум программистов, компьютерный форум, программирование
Powered by vBulletin
Copyright ©2000 - 2026, CyberForum.ru