PythonTweet本日はPython入門記事です。Generator」がおすすめ!docstringとコードスニペットまとめPythonのコメントの書き方Pythonのインラインコメントは#始まりで記述します。#以降の記述がコメントとして扱われます。!'.format(name))Javaだと/*と*/で囲えばブロックコメントになったりと、言語によってはインラインコメントとブロックコメントで異なる記述方法をしますが、Pythonはブロックコメントでも、インラインコメントと同様の記述方法をします。!'.format(name))ダブルクォーテーションまたはシングルクォーテーション3つに囲まれた箇所は、プログラムでは動作しないので、コメントのように定義できますが、Pythonの定義上はStr型になります。この記述方法を、docstringと呼びます。ダブルクォーテーション3つはコメント?docstringでも複数行をコメントアウトするような使い方ができなくもないですが、注意が必要です。以下のようなリストの2つをコメントアウトする時に、ダブルクォーテーション3つで囲ってしまうと、囲った箇所が文字列を判定され、かつ末尾のカンマがなくなるためにエラーになります。syntaxPythonのコメントアウトは、必ず#で1行ずつコメントアウトするようにしましょう。docstringとはdocstringはモジュール、クラス、メソッドの直下に記述します。docstringにはGoogleスタイル、numpyスタイルなどの記述方法があります。今回はGoogleスタイルを例に記述しています。各スタイルの記述方法については以下の記事が参考になると思います!qiita.comdocstringを書くメリットとして、ソースコードを読んだ時にクラスやメソッドの説明があるとわかりやすいVSCodeなどの統合開発環境のスニペットに説明を表示できるドキュメント生成ツールに利用ができるなどが挙げられます。Pythonのプログラムを書くのであれば、docstringは原則記載すべきです。以下のような、bird.pyというモジュール、クラス、メソッド全てにdocstringを記述したファイルを用意しました。"""バードモジュールバードクラスを定義する。fly!'.format(self.name)まずモジュール(=ファイル名)の説明は、ファイルの先頭に記述します。このモジュール内で何が定義されているかを記述します。"""バードモジュールバードクラスを定義する。"""クラスの説明は、クラス名の下に記述します。docstringそのものはクラス内の要素であるため、インデントが必要です。"""メソッドの説明も、メソッド名の下にインデントして記述します。メソッドの引数、戻り値、発生する例外などを記述できます。"""Note、Attributes、Args、Returns、Raisesなどの記述方法は以下を参考に記述しましょう。2でdocstringの雛形を自動生成可能です。Googleスタイルなどのスタイルも指定できます。marketplace.visualstudio.comdocstringとコードスニペットこれを別のPythonファイルでimportして、docstringがどのように役立つのかを見ていきましょう。以下のPython拡張機能がインストールされている環境で検証しています。marketplace.visualstudio.comまずはbird.pyをimportしたとき、モジュ-ルの説明が見れます。birdモジュール内のBirdクラスを入力しようとしたとき、以下のようにスニペットにクラスに記述したdocstringが表示されます。Bird()と入力すると、__init__()のdocstringが表示されます。Argsを記述していると、入力中のパラメータの説明が上部に表示されます。インスタンスメソッドも同様にスニペットでdocstringが表示されます。以上で確認できたとおり、docstringを記述しておけば、そのモジュールを呼び出す時に、毎回定義を確認しなくてすみます。スニペットに表示される説明文を確認するだけで、仕様を把握することができ、プログラミングのスピードも上がります!まとめ以上、今回はPythonのコメントとdocstringについてをまとめました。誰が見てもわかるコメント、docstringを書くことはプログラミング上達のために欠かせない能力です。docstringを簡潔に書くことができれば、メソッドやクラス分けも適切に行うことができ、読みやすいコードになると思います。APIをサクッと作成してみるこんにちは、今回はPythonのWebフレームワークFlaskを用いて、W...2022-03-09TypeScriptはじめました皆さん、JavaScriptはお好きですか?僕は苦手です。僕は...2022-03-02【Python入門】エラー時の自動リトライの仕組みを実装するよくプログラムから外部のAPIにリクエストを投げるときに、たま...2021-11-22【Python入門】Pythonのロギングと真剣に向き合うこんにちは、将来の夢が最近「ログハウスのサウナ小屋を建てた...2021-08-24【BigQuery演習】JSON文字列をSQLで展開してみよう!【JSON関数】おはようございます。はてなブログPro都内でGCP、Python使ったデータエンジニアやってます。クラウドでの設計~開発・運用まで全部やります。20代文系エンジニアです。GCP、Python中心に、データエンジニアとして学んでいる技術をご紹介する記事を書いています。BigQueryとAirflowとバイクと鳥が好き。アイコンはたまたまお魚を加えていたときのカワセミさん。引用をストックしましたストック一覧を見る閉じる引用するにはまずログインしてくださいログイン閉じる引用をストックできませんでした。再度お試しください閉じる限定公開記事のため引用できません。