[B! document][Python] djakarta-trapのブックマーク

djakarta-trap id:djakarta-trap

documentとPythonに関するdjakarta-trapのブックマーク (2)

[Python]可読性を上げるための、docstringの書き方を学ぶ（NumPyスタイル） - Qiita
日々Pythonの色々な記事がアップされているものの、あまりdocstringに触れている日本語の記事が少ないな・・ということで書きました。そもそもdocstringって？ Pythonの関数だったりクラスだったりに記述するコメントです。 JSDocだったりのPython版です。書き方は、最初結構他の言語と違うな・・という印象を受けました。 docstring書くと何が嬉しいの？後で見直したときに、すぐ内容が把握できるよ Guido の重要な洞察のひとつに、コードは書くよりも読まれることの方が多い、というものがあります。はじめに — pep8-ja 1.0 ドキュメント最初は少し時間がかかっても、書いておくと後でコードを読み直した時の負担が減ります。関数などを扱う際に、内容を見たりできるよ jupyter などであれば、nbextentionsでhinterlandを有効化する
djakarta-trap 2018/11/14
python

docstring

document
リンク
Sphinx-Users.jp
Sphinx-Users.jp¶ Sphinx-Users.jp(略称#sphinxjp)は、美しいドキュメントを簡単に生成することができるドキュメンテーションツール、 Sphinx （スフィンクス）の普及を主眼としたコミュニティです。SphinxはPythonの公式ドキュメントだけでなく、このSphinx-Users.jpのサイトも含め多くのマニュアルやサイトで使用されており、詳細を Sphinxの歴史で紹介しています。 Sphinx-Users.jp は日本の Sphinx コミュニティです。 Sphinx-Users.jp では、日本で散らばっているSphinx関連情報を集めて、Webサイト、イベントを通じてSphinx情報を発信します。 slack のコミュニケーションや勉強会の開催などを通じて、ドキュメントをパワーアップしたい人、ドキュメントや翻訳で苦労している人、Sphinxの
djakarta-trap 2013/06/09
ドキュメント生成

ドキュメント

Python

Sphinx

document
リンク
1