Я знаю два способа оставлять комментарии в python. Один использует """, а другой использует #. Я знаю, что первое можно использовать для возврата справки по функциям в качестве преимущества. Но когда я должен использовать один и когда другой? А также как я должен оставлять комментарии? Должен ли я нажимать вкладку и размещать первую строку комментария с командой под ней? Или мне нужно начинать с начала строки?
Правильный способ комментирования команд в python
comment
python.org/dev/peps/pep-0008/#comments
- person Maxime Chéramy schedule 23.06.2013
Ответы (1)
Нет, есть только один способ комментирования, используя # :
Комментарий начинается с символа решетки (#), который не является частью строкового литерала, и заканчивается в конце физической строки.
Тройные кавычки, """, создают строковый объект, который используется в качестве строки документации, когда он является первой строкой функции, модуля или класса. Тройные кавычки полезны и во многих других местах, но их не следует путать с комментариями. Вы можете использовать строку в тройных кавычках, как и любой другой строковый литерал, с тем преимуществом, что вы можете использовать фактические символы новой строки в исходном коде вместо использования управляющих символов \n.
Хотя его можно использовать для отключения блока кода путем преобразования его в многострочную строку, на самом деле вам не следует не этого делать. Используйте надлежащий контроль исходного кода и просто удалите блок или используйте редактор, который позволяет вам комментировать целые блоки, вставляя вместо вас #.
Для реальных комментариев используйте #. В руководстве по стилю Python (PEP 8) есть что сказать о когда и как использовать комментарии; это говорит об отступах:
Блочные комментарии обычно применяются к некоторому (или всему) коду, следующему за ними, и имеют отступ на том же уровне, что и этот код. Каждая строка блочного комментария начинается с # и одного пробела (если это не текст с отступом внутри комментария).
person
Martijn Pieters
schedule
23.06.2013
