Pythonのメソッドやファイルの先頭に出てくる”””(ダブルクオーテーション3つ)

『テスト駆動Python』という本を買って頭からやっていたところ、サンプルコードの中に以下のような記述がありました。

def test_defaults():
    """Using no parameters should invoke defaults."""
    t1 = Task()

この Using no parameters … という部分、これなんだろうと思って調べてみたところ、docstringというものなのですね。

参考:Pythonのdocstring(ドキュメンテーション文字列)の書き方 | note.nkmk.me

Javaで言うところのJavaDoc的なもの?と勝手に理解しました。が、ググっても情報が少なめな気が。

そしてdocstringにの中にテストを書いて実行させるdoctestなるものもあるらしい。

この記事を書いた人

yoshikiito

都内でテストエンジニア&ブロガーをやっている@yoshikiitoです。

ソフトウェアエンジニアの学習方法や成長するための考え方、会社に依存せず自分の力で生きていけるエンジニアになる方法などについて興味があります。
こういった方法や考え方、自分が試したことなどをブログを通じて発信します。

仕事は主にソフトウェアテストやテスト自動化。
趣味は浦和レッズと読書と技術書を買って積むこと。

技術評論社から本を出すのが夢