vscodeでPythonのdocstringを作成する方法を現役エンジニアが解説【初心者向け】
初心者向けにvscodeでPythonのdocstringを作成する方法について現役エンジニアが解説しています。docstringとはPythonの関数やクラスに記述するコメントの事を指します。vscodeの機能を使って簡単に書けるようにautoDocstringをインストールします。
テックアカデミーマガジンは受講者数No.1のプログラミングスクール「テックアカデミー」が運営。初心者向けにプロが解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。 ※ アンケートモニター提供元：GMOリサーチ株式会社 調査期間：2021年8月12日～8月16日 調査対象：2020年8月以降にプログラミングスクールを受講した18～80歳の男女1,000名 調査手法：インターネット調査
vscodeでPythonのdocstringを作成する方法について、TechAcademyのメンター（現役エンジニア）が実際のコードを使用して、初心者向けに解説します。
Pythonについてそもそもよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。
なお本記事は、TechAcademyのオンラインブートキャンプ、Python講座の内容をもとに紹介しています。
今回は、Pythonに関する内容だね！
どういう内容でしょうか？
vscodeでPythonのdocstringを作成する方法について詳しく説明していくね！
お願いします！
今回は、vscodeでPythonのdocstringを作成する方法について紹介します。
docstringとは
まずはじめに、docstringとはPythonの関数やクラスに記述するコメントの事を指します。docstringを記述する事で、コードの可読性が向上します。
docstringの基本的な記述ポイントは以下の3点になります。
- コメントを複数行のコメントブロック「”””」で囲み、最初の「”””」の右隣にタイトルを記載する
- docstringは基本的にimportよりも前に記載する
- docstringを記述できるのは、 モジュール、クラス、関数(メソッド)の3つが対象となる
docstringの作成に便利なvscodeの拡張機能
ここではdocstringの作成に便利なvscodeの拡張機能「autoDocstring」について紹介します。
導入方法
導入方法は以下の画像を参考に、拡張機能の検索から「autoDocstring」を入力すると出てくるのでそちらをインストールしてください。
Installボタンをクリックし以下のような画面になったらインストール完了です。
初期設定
ここでは先ほどインストールしたautoDocstringを使用して挿入するdocstringのフォーマットを設定します。VScode左下の歯車のマークからSettingsを選択し設定画面を開きます。
設定画面が開いたら、検索欄にautoDocstringと入力し、Auto Docstring: Docstring Formatの部分が表示されますのでリストから任意のフォーマットを指定します。(今回はGoogleを選択しました。)
以上で、autoDocstringの初期設定は終了です。
実際に使ってみよう
それでは、早速「autoDocstring」を使用して実際にdocstringを記述してみましょう。vscodeを起動し、以下のようなサンプルコードを用意します。
このコードはあくまで例としてであり、特に指定はないので自由に設定して大丈夫です。
サンプルコード
def docstring_sample(test):
pass
vscode画面
vscode画面上で右クリック→GenerateDocstringで自動的にdocstringが挿入されます。
「autoDocstring」を使用してdocstringが挿入された状態が以下の画面になります。
挿入されたdocstringに関数の説明や引数の説明を入力します。
まとめ
今回は、vscodeでPythonのdocstringを作成する方法について紹介しました。
記事冒頭でも述べたように作成したコードにdocstringを挿入する事でコードの可読性が向上します。
過去に作成したプログラムを再度アップデートする際や、プログラムを複数人で開発する際などにdocstringが挿入されていることでコードが読みやすくなり作業をスムーズに行うことができるというようなメリットがありますので、コードを書く際の癖としてしっかり身につけていきましょう。
コスパとタイパ、両方結果的に良くなる良くなる学び方とは？
「スクールは高いし時間も縛られて効率が悪い」と考える方は多いと思います。
もちろん、時間も費用もかかることは間違いありません。
ただ
結果的に無駄な学びにお金も時間もかける方がリスクが高いという考えもあります。
コスパ・タイパ最適化の参考として、
テックアカデミー卒業生がスクールを選んだ理由
をご紹介します。
- ・困ったときに、質問や相談できる相手がいるため挫折しなかった
- ・プロとして必要なスキルのみを深く学べたので無駄がなかった
- ・副業案件の提供と納品までのサポートがあったので目的を達成できた
安価・短期間で広く浅く学んでも意味がありません。
本当に自分の目的が達成できるか、それが重要です。
自分にどのスキルや学び方が合っているか、どんな学習方法かなど、お気軽に
無料相談
に参加してみませんか？
カウンセラー・現役のプロへ、何でも気軽に無料相談可能。
30分か60分お好きな時間が選べて、かつ3回まで
すべて無料で
ご利用できます。
無理な勧誘は一切ない
ので、お気軽にご参加ください。
監修してくれたメンター
| 菅繕久（すがよしひこ）
現在はフリーランスのエンジニアをしていてプログラミング歴は8年目になります。 普段は Python、FileMaker等を使って様々な業務で活用できるIoTプロダクトRPAツールを作成しています。 |
内容分かりやすくて良かったです！
ゆかりちゃんも分からないことがあったら質問してね！
分かりました。ありがとうございます！
TechAcademyでは、初心者でも、Pythonを使った人工知能（AI）や機械学習の基礎を習得できる、オンラインブートキャンプを開催しています。
また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。
プログラミングを独学で学習していて、このように感じた経験はないでしょうか？
- ・調べてもほしい情報が見つからない
- ・独学のスキルが実際の業務で通用するのか不安
- ・目標への学習プランがわからず、迷子になりそう
テックアカデミーでは、このような
学習に不安を抱えている方へ、マンツーマンで相談できる機会を無料で提供
しています。
30分間、オンラインでどんなことでも質問し放題です。
「受けてよかった」と感じていただけるよう
カウンセラーやエンジニア・デザイナー
があなたの相談に真摯に向き合います。
「自分に合っているか診断してほしい」
「漠然としているが話を聞いてみたい」
こんなささいな悩みでも大丈夫です。
無理な勧誘は一切ありません
ので、まずはお気軽にご参加ください。
※体験用のカリキュラムも無料で配布いたします。（1週間限定）
