Есть ли механизм для комментирования больших блоков кода Python? Прямо сейчас, единственный способ закомментировать код - это начать каждую строку с # или заключить код в тройку ...
Как говорится в этом вопросе, я хочу знать, можно ли просмотреть код (doc string) для просмотра его содержимого и узнать, как он написан / отформатирован. Он не обязательно должен быть через оболочку python, ...
Я пытаюсь улучшить число и качество тестов в моих проектах Python. Один из трудности, с которыми я встретился как количество тестового увеличения, знают то, что делает каждый тест и как это...
Что, по Вашему мнению значимый docstring? Что Вы ожидаете быть описанными там? Например, рассмотрите этот класс Python __ init __: определение __ init __ (сам, имя, значение, displayName=None...
Мне нравится doxygen для создания документации кода на C или PHP. У меня есть предстоящий проект Python, и я думаю, что я помню, что Python не имеет / * .. * / комментариев, а также имеет свою собственную документацию ...
docstrings Python и комментарии хранятся в памяти, когда модуль загружается? Я задался вопросом, верно ли это, потому что я обычно документирую свой код хорошо; это может влиять на использование памяти? Обычно каждый...
У меня есть проблема с помощью docstrings с декораторами. Учитывая следующий пример: декоратор определения (f): определение _decorator (): распечатайте 'декоратора, активного' f (), возвращают _decorator @decorator...
Действительно ли возможно добавить строку документации к namedtuple в непринужденной манере? Я попробовал от Точки namedtuple импорта наборов = namedtuple ("Точка", ["x", "y"]) """ точка в 2D пространстве"
Существует ли способ описать данные модуля похожим способом, которым docstring описывает модуль или funcion? класс MyClass (объект): определение my_function (): """Этот docstring работы!"""...
Я записал epytext для отдыха преобразователя разметки, и теперь я хочу преобразовать все docstrings в своей всей библиотеке от epytext для отдыха формата. Есть ли умный способ считать все docstrings...
Я пытаюсь задокументировать @property в модуле python и не могу найти строку документации в справке свойства Я хотел бы позвонить в справку (class.property), чтобы напечатать справку только для этого ...
Я хотел бы описать структуру DataFrame, которую ожидает моя функция Python, и словесное описание, например: def myfun (input): "" "Делает что-то. Параметры ---------- input: pandas ... ,
Я использую PyCharm IDE, которая помогает создавать строки документов, совместимые с PEP0257. Он предоставляет два атрибута, которые я не совсем понимаю различие / использование между:: повысить Исключение: исключение ...
Я пишу легкий класс, атрибуты которого предназначаются, чтобы быть публично доступными, и только иногда переопределяются в определенных инстанцированиях. Нет никакого условия на языке Python для...
Я хотел бы запустить программу проверки правописания на docstrings моего кода Python, если это возможно, из emacs. Я нашел установку ispell-check-comments, которая может использоваться для проверки правописания только комментариев в...
Это - допустимый JavaScript для записи чего-то вроде этого: функциональным примером (x) {"Вот является короткий документ, что я делаю".;//код функции} строка на самом деле ничего не делает. Есть ли любая причина...
Там какой-либо путь состоит в том, чтобы просмотреть строку документа функции при записи Python в VIM? Например: определение MyFunction (спам): """Функция, что foobars яйца возвратов спама""" возвращают foobar (спам)....
Как добавить строки документации и/или комментарии к библиотекам/пространствам имен Clojure в целом, то есть не только к конкретным функциям в пространстве имен? Я заметил, что исходный код clojure использует комментарий (... )в...
У меня есть класс, который собирается проанализировать базу данных и создать n количество атрибутов, где каждый атрибут представляет собой массив NumPy данных в базе данных, а имя этого атрибута является переменной ...
В настоящее время я начинаю с Python, и у меня большой опыт работы с PHP, а в PHP я привык использовать javadoc в качестве шаблона документации. Мне было интересно, есть ли у javadoc место в качестве ...
Можно ли создать индекс в Sphinx, который создается конкретными (или настраиваемыми) элементами в docstring? Например, у меня есть следующая функция и хотелось бы, чтобы Sphinx создал ...
Я хотел бы иметь возможность реализовывать пользовательские аннотации в моих объектах PHP5, и я хотел бы узнать, как работает весь процесс, создав свой собственный синтаксический анализатор. Однако для начала мне нужно знать, как НАЙТИ...
Итак, я пытаюсь создать «динамическую» строку документации, которая выглядит примерно так :ЖИВОТНЫЕ _ТИПЫ = ["млекопитающие", "рептилии", " другое"] def func (animalType ):""" Это пример функции. @param...
У меня есть сценарий Python со строкой документации. Когда синтаксический анализ аргументов командной строки не удается, я хочу распечатать строку документации для информации о пользователе. Есть какой-либо способ сделать это? ...
Я хочу напечатать строку документации функции Python из самой функции.
для напр. def my_function (self): "" "Строка документа для моей функции." "" # напечатайте здесь строку документа. В настоящий момент я ...
Я только начинаю изучать Python и использую Emacs в качестве своего редактора. В настоящее время Emacs использует один и тот же цвет для обычных строк (одинарные кавычки) и строк документации (тройные кавычки). Я хочу, чтобы строки документации были ...
Инструменты, подобные pep8, могут проверять стиль исходного кода, но они не проверяют, имеют ли строки документации атрибуты в соответствии с pep257, pep287. Есть такие инструменты? Update Решил реализовать такой статический анализ ...
Я хотел бы сослаться на ранее задокументированный параметр функции в другом месте строки документации Python. Рассмотрим следующий (по общему признанию, полностью искусственный) пример: def foo(bar): """Perform foo ...
Возможно глупый вопрос :как можно указать строку документации для специальных функций, таких как __init __, при написании расширения C? Для обычных методов в таблице методов предусмотрены строки документации. Следующие...