pythonのプログラミング初心者に向けて入門編の内容をご紹介していきたいと思います。場合によっては人工知能はディープラーニングについても解説していく予定です。

この記事ではPythonでよく登場する
docstringの活用法についてわかりやすく解説します。

【Python】docstringの活用法

まず例題1をご覧ください。

#例題1

def ninzu(kazu1, kazu2):
    """
    ここでファンクションのドキュメントを書きます。
    その場合にはダブルクォーテーション3つでくくればよいです。
    この中は実行されなくなります。
    
    """

まず

def ninzu(kazu1, kazu2):

として関数定義をおこなっています。

「関数定義って何？」と気になる方は
こちらの記事をご覧ください。
⇒関数定義についてPython初心者にもわかるように解説

で、関数の中に

　　"""
    ここでファンクションのドキュメントを書きます。
    その場合にはダブルクォーテーション3つでくくればよいです。
    この中は実行されなくなります。
    
    """

といった感じで『ダブルクォーテーション3つ』をつけて
ドキュメントを書くことができます。

こうすることで、実行されなくなります。

ここでは関数の説明を

def ninzu(kazu1, kazu2):

の下にダブルクォーテーション3つを使って
記述していくということを覚えておきましょう。

あと、もう一つ知っておいてほしいことがあります。

例題2をご覧ください。

#例題2

def ninzu(kazu1, kazu2):
    """
    ここでファンクションのドキュメントを書きます。
    その場合にはダブルクォーテーション3つでくくればよいです。
    この中は実行されなくなります。
    
    """

print(ninzu.__doc__)

例題2を実行すると

と表示されます。

こんな感じで

.__doc__

とすることで、ダブルクォーテーション3つの中身の記述を
表示させることができるようになります。

たとえば

.__doc__

を他のツールを使ってドキュメントの部分を読み込んで
html化すれば、ウェブ上で見ることができるようになります。

以上で解説を終わります。