docstringを使うと、Pythonのコードを書きながら、同時にそのドキュメントも作成できる。関数のdocstringを例にその基本的な書き方を見ていく。 本連載の第5回「文字列の基本」の「トリプルクオート文字列」でも触れたが、Pythonではシングルクオート「'」また ...
今回は、Pythonのdocstring(ドックストリング)についてまとめてみました。 docstringは、Pythonコードの可読性を向上させるための非常に便利なツールです。特に、Pythonを学んでいる方や、コードの品質を向上させたい方にお役に立てればと思い執筆しました。
コードに「説明書(ドキュメント)」を埋め込むための公式な方法です。 三重クォート(""" ... """)の文字列。 コードの説明文で、help()コマンドやツールから読める。 例: def say_hello(): """うさうさ店長があいさつします。""" print("🐇 こんにちは、うさうさ ...
2025年11月版のPython拡張機能ではマウスホバーに表示される自動生成された要約をdocstringとして追加したり、それを自分の言語(日本語など)に自動翻訳したりする機能が追加された。これにより、コード編集がさらに快適になりそうだ。 新機能の目玉は、VS ...
この PEP の目的は、docstring (ドキュメンテーション文字列、以降 docstring) の高いレベルでの構造を標準化することにあります。 つまり、どんな情報を含めるべきか、そしてどのように (docstring のマークアップの範囲内で) docstring を書くべきかといった指針です。
一部の結果でアクセス不可の可能性があるため、非表示になっています。
アクセス不可の結果を表示する