今回は、Pythonのdocstring(ドックストリング)についてまとめてみました。 docstringは、Pythonコードの可読性を向上させるための非常に便利なツールです。特に、Pythonを学んでいる方や、コードの品質を向上させたい方にお役に立てればと思い執筆しました。
「Pythonのdocstringの書き方」で有名どころを押さえておくと、他人のコードを読んだり自分で書いたりするときにとても役立ちます。 Python では docstring(ドキュメンテーション文字列) のフォーマットとして、以下のスタイルがよく使われます。 Googleが公開 ...
This module demonstrates documentation as specified by the `Google Python Style Guide`_. Docstrings may extend over multiple lines. Sections are created with a section header and a colon followed by a ...