Python: docstring を書いてみよう - CUBE SUGAR CONTAINER

Python の docstring というのは、モジュールやクラス、関数などにつける説明文のこと。 単純なコメントとの違いは、より仕様に近い内容を記述しておくことで API のドキュメントとして利用できる他、別のドキュメントから内容を読み込んで使ったりすることができる。 今回は docstring の書かれたサンプルコードを元に、REPL からその内容を参照したり、ドキュメンテーションツール Sphinx でその内容を読み込むというのを試してみる。 docstring の書かれたソースコードを用意する 以下が docstring の書かれた Python のソースコード。 内容については FizzBuzz 問題を題材にしている。 モジュールや関数の先頭で “”“ や ‘’‘ を使ってコメントを書いておくと、それが自動的に docstring として扱われることになる。 #!/usr/bi

[yamanetoshi]

“#!/usr/bin/env python # -*- coding: utf-8 -*-”

[kita-tuba]

Python: docstring を書いてみよう

[axnsword]

ドキュメント