2013-09-06 7 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)の使用を標準化しています。私はPyCharmのdocstringサポートが大好きですが、epytextとreStructureTextだけが現在サポートされているフォーマットは2つです。私は、自分自身を書くつもりで、PyCharmプラグインを使って、GoogleまたはNumpydocスタイル(https://pypi.python.org/pypi/sphinxcontrib-napoleon/)のいずれかでフォーマットされたドキュメントコメントスタブを作成したいと思います。特に重要なのは、PyCharmが持つ型推論能力と他の2つのドキュメント型を取り入れることです。

+4

HTTPのように見える:// youtrack.jetbrains.com/issue/PY-9795。 – CrazyCoder

答えて

68

PyCharm 5.0では、最終的にGoogle and NumPy Style Python Docstringsテンプレートを選択する必要がありました。

PyCharm 5.0のwhatsnewセクションにも記載されています。ドキュメンテーション文字列の書式を変更する方法

ファイル] - > [設定] - > [ツール] - > [Pythonの統合ツール

あり、使用可能なドキュメンテーション文字列の形式から選択できます。

平野、Epytext、reStructuredTextの、numpyのは、Google

としてはjstolによって指摘:Macユーザーのために、これは

PyCharmの下にある - >設定 - >ツール - > Pythonの統合されたツール。ただ、PyCharm 5.0のように、@Nrasが明示的に答える作るべき

+6

Macユーザーの場合、これはPyCharm - > Preferences - > Tools - > Python Integrated Toolsの下にあります。 – jstol

+2

私は新しいプロジェクトを開始するときにこの選択をする方法はありますか?毎回この設定を狩りざるを得ないのは痛みです。 – superbeck

+1

この回答を更新して、jstolのコメントに情報を含めることを検討してください –

4

CrazyCoderには、次のように記載されています。ticket。現在、EpyTypereStructuredTextしか使用できません。

1

ファイル]> [設定]> [ツール]> [Pythonの統合ツール>ドキュメンテーション文字列を> Googleの

関連する問題