ドキュメントコメントを作成する
Python 関数のドキュメントコメントの作成
Python 関数のドキュメントコメントを作成するには
文書化する関数の宣言の 後にキャレットを置きます。
三重引用符を開いて入力し、 Enter または Space を押します。
パラメーターと戻り値の意味のある説明を追加します。
インテンションアクションを使用して Python 関数のドキュメントコメントを作成するには
キャレットを、文書化したい関数のどこかに置きます。
Alt+Enter を押して、利用可能なインテンションの動作を表示します。
ドキュメント文字列スタブを挿入する を選択します。
PyCharm は、 Python 統合ツールページで選択された docstring フォーマットに従ってドキュメントコメントスタブを生成します。
Python ドキュメントコメントの例
以下の関数を考えてみましょう:
def handle(self, myParam1, myParam2):
設定 Ctrl+Alt+S を開き、 に移動します。
Docstring フォーマット ドロップダウンで、 reStructuredText を選択します。
次に、開始の三重二重引用符を入力し、 Enter または Space を押します。 PyCharm は、 reStructuredText 形式でドキュメントコメントスタブを生成します：
"""
:param self:
:param myParam1:
:param myParam2:
:return:
"""
マークアップは、テキストのフォーマットだけでなく、置換、箇条書きリスト、リンク、コードブロック、表にも使用できます。
2026 年 6 月 1 日