ソースコードをドキュメント化する

基本

PyCharm は、ドキュメントコメントを作成するための便利な機能を提供します。

ソースコード内のドキュメントコメントは コードリファレンス情報 で利用でき、 Ctrl+Q を押すとレビューが開きます。

Python のドキュメント

ドキュメントコメントは、プロジェクト設定 (Ctrl+Alt+S) の Python 統合ツールページで選択した構文に従って作成できます。

この機能が関数に適用される場合は、選択された docstring 形式に応じて PyCharm がタグを生成します。

例: reStructuredText の場合: 関数シグネチャーで宣言された各パラメーターの :param タグと :return タグ。

構成されている場合、ドキュメントのコメントスタブは type および rtype タグで生成できます。

Python ファイルで、PyCharm は Python docstrings として記述されたドキュメントコメントを認識します。

始める前 にの場合、設定ダイアログの 統合ツールページで必要な docstring 形式が選択されていることを確認してください。

また、PyCharm が conf.py からカスタムロールを取得することにも注意してください。 *.rst ファイルを含むディレクトリを設定する場合は、 conf.py （Python 統合ツール | * .rst ファイルのあるディレクトリへのパス ）を使用してディレクトリを指定します。