PyCharm 2026.1 ヘルプ

ドキュメントコメントを作成する

Python 関数のドキュメントコメントの作成

Python 関数のドキュメントコメントを作成するには

  1. 文書化する関数の宣言の後にキャレットを置きます。

  2. 三重引用符を開いて入力し、Enter または Space を押します。

  3. パラメーターと戻り値の意味のある説明を追加します。

インテンションアクションを使用して Python 関数のドキュメントコメントを作成するには

  1. キャレットを、文書化したい関数のどこかに置きます。

  2. Alt+Enter を押して、利用可能なインテンションの動作を表示します。

  3. ドキュメント文字列スタブを挿入するを選択:

    Intention action: Insert documentation stub

    PyCharm は、Python 統合ツールページで選択されたドキュメント文字列形式に従ってドキュメントコメントスタブを生成します。

Python ドキュメントコメントの例

以下の関数を考えてみましょう:

def handle(self, myParam1, myParam2):

設定 Ctrl+Alt+S を開き、Python | ツール | 統合ツールに移動します。

Docstring フォーマットドロップダウンで、reStructuredText を選択します。

次に、開始の三重二重引用符を入力し、Enter または Space を押します。PyCharm は、reStructuredText 形式でドキュメントコメントスタブを生成します。

""" :param self: :param myParam1: :param myParam2: :return: """

マークアップは、テキストのフォーマットだけでなく、置換、箇条書きリスト、リンク、コードブロック、表にも使用できます。

2026 年 1 月 21 日
ドキュメントのコメントを管理する リファレンスドキュメントを生成する