【プログラミング】ドキュメンテーション文字列

Pythonを少しずつ勉強しています。

基礎的な箇所で、フワッとしているところを再度、チェックと整理しておこうと思います。

１．今回の内容

今回は”ドキュメンテーション文字列”についての内容になります。

ドキュメンテーション文字列（docstring）とは、関数が何をするか、どのような引数を使うかなどをドキュメント化した文字列のこと。

[関数定義]
    """
    [関数の目的]
    [関数の引数]
    [引数の型]
    [関数が返す値]
    """

関数定義をした後に、”””で囲って、関数の目的から関数の引数や、引数の型、関数が返す値といった内容を記載。

誰が読んでも関数の内容が分かるようにするのが、目的のようです。

※参考文献

独学プログラマー Python言語の基本から仕事のやり方まで

２．まとめ

引き続き、基礎的なところを整理して、応用していけるようになれたらと考えてます。

（※前回の内容）

--------------------------------------------------------------------------------------

毎日更新できるように日々研究を重ねて行ければと思います。
最後まで読んで頂き、ありがとうございます。