Результаты поиска по запросу "docstring"
Обычно целью добавления добавления строки документа в начало функции является описание функции, что она делает, что она будет возвращать, и описание параметров. Вы можете добавить детали реализации, если это необходимо. Даже вы можете добавить информацию об авторе, который написал код для будущего разработчика.
по вашему мнению, является значимой строкой документации? Что вы ожидаете, что там будет описано? Например, рассмотрим этот класс Python__init__: def __init__(self, name, value, displayName=None, matchingRule="strict"): """ name - field name ...
Что означают эти форматы в витой документации?
В искаженном исходном коде многие строки документации содержат такие форматы: L {xxx} или C {xxx}, или строка начинается с символа @, каковы их значения? на...
Ссылка на параметры в строке документации Python
Я использую Sphinx и функцию autodocs, чтобы у нас были хорошие документы в нашем проекте.Так что я'я знаком ссписки информационных полей и я'я знако...
@ Зейн, я согласен. Как любитель Doxygen, я слишком сильно упустил полностью автоматическое создание справочников по API. Проверьте мой ответ, так как некоторые другие опции теперь доступны.
равится doxygen для создания документации кода на C или PHP. У меня есть предстоящий проект Python, и я думаю, что я помню, что Python не имеет/* .. */ комментарии, а также имеет свой собственный механизм самодокументирования, который, кажется, ...
Ссылка на параметры в строке документации Python
Я использую Sphinx и функцию autodocs, чтобы у нас были хорошие документы в нашем проекте. Итак, я знаком ссписки информационных полей [http://sphinx-doc.org/domains.html#info-field-lists]и я знаком с использованием перекрестные ...
Документирование типа возврата `tuple` в строке документации функции для хинтинга типа PyCharm
Как я могу документировать, что функция возвращаетtuple таким образом, что PyCharm сможет использовать его для подсказок типа? Придуманный пример: def fetch_abbrev_customer_info(customer_id): """Pulls abbreviated customer data from the database ...