Результаты поиска по запросу "docstring"
Как программно установить строку документации?
У меня есть функция-обертка, которая возвращает функцию. Есть ли способ программно установить строку документации возвращаемой функции? Если бы я мог написать
Как сделать атрибуты объекта документа Python / Sphinx, объявленные только в __init__?
У меня есть классы Python с атрибутами объекта, которые объявлены только как часть запуска конструктора, например, так:
Как мне документировать: rtype: для функции, которая возвращает несколько возможных типов данных? [Дубликат]
На этот вопрос уже есть ответ: Как указать несколько типов возвращаемых данных, используя подсказки типа [/questions/33945261/how-to-specify-multiple-return-types-using-type-hints] 2 ответа В документации на Python как следует ...
@ Зейн, я согласен. Как любитель Doxygen, я слишком сильно упустил полностью автоматическое создание справочников по API. Проверьте мой ответ, так как некоторые другие опции теперь доступны.
равится doxygen для создания документации кода на C или PHP. У меня есть предстоящий проект Python, и я думаю, что я помню, что Python не имеет/* .. */ комментарии, а также имеет свой собственный механизм самодокументирования, который, кажется, ...
Моя проблема с тройными кавычками состоит в том, что они фактически проверяются на синтаксис. это должно быть накладные расходы, которые не нужны для комментария. Пример: если у вас был '' '/ NPF' '' и вы запустили его в Python 3, он выдаст синтаксическую ошибку. Итак, Python 3 проверяет каждую тройную кавычку на правильность синтаксиса. Если вы переключитесь на # и прокомментируете строку, она пропускается.
от вопрос уже есть ответ здесь: Почему в Python нет многострочных комментариев? [/questions/397148/why-doesnt-python-have-multiline-comments] 16 ответовЕсть ли механизм для комментирования больших блоков кода Python? Прямо сейчас, единственный ...
Почему строка документации Python интерпретируется иначе, чем комментарий
Допустим, у меня есть такая функция: def myFunc(): # useful function to calculate stuffЭто приведет к ошибке отступа, если я не добавлюpass: def myFunc(): # useful function to calculate stuff passОднако, если я заменю комментарий на строку ...