VSCodeでPythonのdocstringを自動生成できる拡張機能「Python Docstring Generator」

環境

  • Windows 10
  • Python 3.10.1

docstringとは

  • docstringは、javascriptのjsdocやphpのphpdocに相当するもの
  • docstringを記述していれば、エディタ上でカーソールを合わせるとその関数等の定義を確認することが可能なので、とても便利
  • 保守性や可読性があがり、特にチーム開発で役立つ

導入手順

Vscodeで拡張機能「Python Docstring Generator」をインストールする

使用方法

  • 関数宣言の直下で”””を入力するとGenerate docstringという入力支援が表示されるので、Enterを押下するとdocstringが自動的に挿入される
  • あとは、その関数にあった引数や返り値の内容に編集してあげるだけ
def join_to(self, relative_path):
  """基底パスに任意の相対パスを結合したurlを返します
  Args:
    relative_path ([str]): [相対パス]
  Returns:
    joined_url [str]: [基底パスに任意の相対パスを結合したurl]
  """
  return urljoin(self.get_baseurl(), relative_path)

以上です

Python学習におすすめの書籍

独習Python/山田祥寛【3000円以上送料無料】
bookfan 1号店 楽天市場店
¥ 3,300(2022/08/04 17:32時点)
タイトルとURLをコピーしました