[Python]可読性を上げるための、docstringの書き方を学ぶ（NumPyスタイル） - Qiita
Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? 日々Pythonの色々な記事がアップされているものの、あまりdocstringに触れている日本語の記事が少ないな・・ということで書きました。 そもそもdocstringって？ Pythonの関数だったりクラスだったりに記述するコメントです。 JSDocだったりのPython版です。 書き方は、最初結構他の言語と違うな・・という印象を受けました。 docstring書くと何が嬉しいの？ 後で見直したときに、すぐ内容が把握できるよ Guido の重要な洞察のひとつに、コードは書くよりも読まれることの方が多い、というものがあります。 はじめに
![[Python]可読性を上げるための、docstringの書き方を学ぶ（NumPyスタイル） - Qiita](https://cdn-ak-scissors.b.st-hatena.com/image/square/117f7596f84d03a571f149bb9489a01a860ef179/height=288;version=1;width=512/https%3A%2F%2Fqiita-user-contents.imgix.net%2Fhttps%253A%252F%252Fcdn.qiita.com%252Fassets%252Fpublic%252Farticle-ogp-background-412672c5f0600ab9a64263b751f1bc81.png%3Fixlib%3Drb-4.0.0%26w%3D1200%26mark64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTk3MiZoPTM3OCZ0eHQ9JTVCUHl0aG9uJTVEJUU1JThGJUFGJUU4JUFBJUFEJUU2JTgwJUE3JUUzJTgyJTkyJUU0JUI4JThBJUUzJTgxJTkyJUUzJTgyJThCJUUzJTgxJTlGJUUzJTgyJTgxJUUzJTgxJUFFJUUzJTgwJTgxZG9jc3RyaW5nJUUzJTgxJUFFJUU2JTlCJUI4JUUzJTgxJThEJUU2JTk2JUI5JUUzJTgyJTkyJUU1JUFEJUE2JUUzJTgxJUI2JUVGJUJDJTg4TnVtUHklRTMlODIlQjklRTMlODIlQkYlRTMlODIlQTQlRTMlODMlQUIlRUYlQkMlODkmdHh0LWFsaWduPWxlZnQlMkN0b3AmdHh0LWNvbG9yPSUyMzFFMjEyMSZ0eHQtZm9udD1IaXJhZ2lubyUyMFNhbnMlMjBXNiZ0eHQtc2l6ZT01NiZzPTQxZDA5Yzc3OGE5N2FiNWE2ZGRmMjQ2NDdjMTcwNWFl%26mark-x%3D142%26mark-y%3D57%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZoPTc2Jnc9NzcwJnR4dD0lNDBzaW1vbnJpdGNoaWUmdHh0LWNvbG9yPSUyMzFFMjEyMSZ0eHQtZm9udD1IaXJhZ2lubyUyMFNhbnMlMjBXNiZ0eHQtc2l6ZT0zNiZ0eHQtYWxpZ249bGVmdCUyQ3RvcCZzPWE3MmIwZGNhMjJjN2FmZWNiMjUzZTBmYzg4N2M5NDZh%26blend-x%3D142%26blend-y%3D486%26blend-mode%3Dnormal%26s%3D4874bd009da4720044c0b6096538898f)
Sphinxの使い方．docstringを読み込んで仕様書を生成 - Qiita
Sphinxによる美しいドキュメント生成 🌟📚 更新履歴 2020年7月19日: Sphinx v3.1.2 を基準とした記述に更新。 2024年6月30日: Sphinx v7.0.0 を基準とした記述に変更。Pythonのバージョンアップ、モジュールの自動検出、Markdownのサポート、テーマのカスタマイズ、自動ビルドとデプロイ、その他について追記しました 1. Sphinxとは？ 🤔 Sphinxは知的で美しいドキュメントを簡単に作れるPython製のドキュメント生成ツールです。 （公式が自称しています） 例えば、下のようなドキュメントが、pythonのソースコードから生成できます。 Sphinxのメリット ✨ 美しいドキュメントを簡単に作成できる: Sphinxには、読みやすく美しいドキュメントを生成するための機能が豊富に用意されています。 Pythonプロジェクトとの親和
業務での利用事例
業務での利用事例¶ 対象 ソフトウェア開発プロジェクト 規模:1名~10名前後 ドキュメント、書いていますか？¶ 想像してみてください。 この規模、たとえば1名のプロジェクトだとしたらどれくらいドキュメントを書くでしょうか？あるいは10名だったとしたら、どんな役割分担でドキュメントを書くでしょう。 そもそも、彼らはいつドキュメントを書くでしょうか。プロジェクトの方針がある場合、無い場合、色々なケースがあると思いますが、ドキュメントを作る事に対してかれらはどんなことを考えるでしょう。 ドキュメントを書いている割合¶ 業務のプロジェクトには大規模なものから小規模なものまでたくさんありますが、その数に対する「ドキュメントを書いている」比率は意外と低いのではないかと思います。前任者や別の部署・会社から引き継いだプロジェクトにまともなドキュメントがほとんどなかった経験がある方もいるのではないでしょう
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
