1. ホーム
  2. python

[解決済み] カスタム PyCharm docstring スタブ (例: google docstring や numpydoc フォーマットの場合)

2023-07-12 07:40:14

質問

PyCharm 2.7 (またはPyCharm 3)では、カスタムdocstringとdoctest stubをサポートしていますか? もしそうなら、この特定のタイプのカスタム拡張を書くにはどうしたらよいでしょうか?

私の現在のプロジェクトでは、Google Python Style Guide ( http://google-styleguide.googlecode.com/svn/trunk/pyguide.html ). 私はPyCharmのdocstringサポートが大好きですが、現在サポートされているフォーマットはepytextとreStructureTextの2つだけです。 私は、Google または Numpydoc スタイルでフォーマットされたドキュメントのコメントスタブを作成する PyCharm プラグインが欲しいし、自分で書く気もあります ( https://pypi.python.org/pypi/sphinxcontrib-napoleon/ ). ここで特に重要なのは、PyCharmが持っている型推論機能を他の2つのドキュメントタイプに組み込むことです。

どのように解決するのですか?

PyCharm 5.0 でようやく GoogleとNumPyスタイルのPython Docstring のテンプレートが選択できるようになりました。

にも記載されています。 whatsnew セクションでも言及されています。

Docstring Format の変更方法です。

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

そこで、利用可能なDocstringsのフォーマットを選択することができます。

Plain、Epytext、reStructuredText、NumPy、Google

jstolが指摘したように、Macユーザーのために、これは以下の通りです。

PyCharm -> 環境設定 -> ツール -> Python統合ツール.