Python基礎 レッスン11
コメントとdocstring
コードに説明を付ける方法とdocstringの書き方
コメントとは？
コメントはプログラムの実行に影響しない説明文です。 コードの意図・なぜそう書いたか・注意点などを記録するために使います。 適切なコメントはコードを読みやすくし、チームでの協業や将来の自分への手がかりになります。
# コメント- 1行コメント（#以降の全てがコメント）"""文字列"""- 複数行コメント（docstringとして使用）__doc__- docstringへのアクセス
コメントの書き方
Pythonプレイグラウンド
docstringとは？
docstringは関数・クラス・モジュールの直後に書く文字列ドキュメントです。help()関数や__doc__属性でアクセスできます。 コードの使い方を自己文書化するために活用します。
- 1行docstring — 簡潔な説明を1行で書く
- 複数行docstring — 概要・引数・戻り値・例を詳しく記述する
- Google スタイル・NumPy スタイル — よく使われる書き方の規約
docstringの書き方と参照
Pythonプレイグラウンド