2013-09-06 37 views
55

Czy PyCharm 2.7 (czy też PyCharm 3) ma obsługę niestandardowych docstrów i doctestów? Jeśli tak, jak można napisać ten typ niestandardowego rozszerzenia?Niestandardowe kody śledzenia docC programu PyCharm (np. Dla google docstring lub formaty numpydoc)

Mój obecny projekt ujednolicił korzystanie z przewodnika po pythonach w stylu Google'a (http://google-styleguide.googlecode.com/svn/trunk/pyguide.html). Uwielbiam obsługę docCringa PyCharm, ale to tylko dwa obsługiwane formaty to teraz epitext i reStructureText. Chcę, i chcę napisać osobiście, wtyczkę PyCharm, która tworzy komentarz do dokumentacji w formacie Google lub Numpydoc (https://pypi.python.org/pypi/sphinxcontrib-napoleon/). Szczególne znaczenie ma tutaj włączenie zdolności wnioskowania typu, jakie PyCharm ma z pozostałymi dwoma typami dokumentacji.

+4

Wygląda na http: // youtrack.jetbrains.com/issue/PY-9795. – CrazyCoder

Odpowiedz

68

W PyCharm 5.0 w końcu mamy do wyboru szablony Google and NumPy Style Python Docstrings. Jest to również wymienione w sekcji whatsnew dla PyCharm 5.0.

Jak zmienić format Docstring:

Plik -> Ustawienia -> Narzędzia -> Python zintegrowanych narzędzi

Nie można wybrać jeden z dostępnych formatów Docstrings:

Plain, Epytext, reStructuredText, NumPy Google

Jak podkreślił jstol: dla użytkowników komputerów Mac, to pod

pycharm -> Preferencje -> Narzędzia -> Python zintegrowanych narzędzi.

+6

Dla użytkowników Mac, jest to pod PyCharm -> Preferencje -> Narzędzia -> Zintegrowane narzędzia Python. – jstol

+2

Każdy pomysł, jak sprawić, by ten wybór pozostał przy rozpoczynaniu nowego projektu? To ból, aby za każdym razem ścigać to ustawienie. – superbeck

+1

Rozważ zaktualizowanie tej odpowiedzi w celu uwzględnienia informacji w komentarzu od jstol –

4

Jak wspomina CrazyCoder, jest to ticket. W tej chwili możesz używać tylko EpyType i reStructuredText.

1

Wystarczy być uczynić @Nras odpowiedzieć jednoznacznie, jak z PyCharm 5.0:

Plik> Ustawienia> Narzędzia> Python zintegrowanych narzędzi> Docstrings> Google