2013-09-06 6 views
55

Поддерживает ли PyCharm 2.7 (или PyCharm 3) пользовательские столбцы docstring и doctest? Если да, то как это делается для написания этого конкретного типа пользовательского расширения?Пользовательские пики PyCharm docstring (т. Е. Для форматов google docstring или numpydoc)

Мой текущий проект стандартизован с использованием Руководства по стилю Google Python (http://google-styleguide.googlecode.com/svn/trunk/pyguide.html). Мне нравится поддержка docstring PyCharm, но сейчас только два поддерживаемых формата - это epytext и reStructureText. Я хочу и хочу написать сам, плагин PyCharm, который создает заглушку комментариев документации, отформатированную в стиле Google или Numpydoc (https://pypi.python.org/pypi/sphinxcontrib-napoleon/). Особое значение здесь имеет использование возможностей вывода типов, которые PyCharm имеет с двумя другими типами документации.

+4

Похоже HTTP: // youtrack.jetbrains.com/issue/PY-9795. – CrazyCoder

ответ

68

С помощью PyCharm 5.0 мы, наконец, должны выбрать Google and NumPy Style Python Docstrings шаблоны.

Также упоминается в разделе whatsnew для PyCharm 5.0.

Как изменить формат: строка документации

Файл -> Настройки -> Сервис -> Python Встроенные инструменты

Там вы можете выбрать один из доступных форматов строк документации:

Plain, Epytext, ReStructuredText, NumPy, Google

Как отметил jstol: для пользователей Mac, это под

PyCharm -> Настройки -> Инструменты -> Python интегрированные инструменты.

+6

Для пользователей Mac это находится в PyCharm -> Настройки -> Инструменты -> Интегрированные инструменты Python. – jstol

+2

Любая идея, как сделать этот отбор, когда я начинаю новый проект? Это боль, чтобы каждый раз выслеживать эту настройку. – superbeck

+1

Рассмотрите возможность обновления этого ответа, чтобы включить информацию в комментарий от jstol –

4

Как упоминает CrazyCoder, его a ticket. Прямо сейчас вы можете использовать только EpyType и reStructuredText.

1

Просто быть сделать @Nras ответить четко, как и из PyCharm 5.0:

Файл> Настройки> Инструменты> Python Встроенные инструменты> Строки документации> Google