環境
- Windows 10
- Python 3.10.1
docstringとは
- docstringは、javascriptのjsdocやphpのphpdocに相当するもの
- docstringを記述していれば、エディタ上でカーソールを合わせるとその関数等の定義を確認することが可能なので、とても便利
- 保守性や可読性があがり、特にチーム開発で役立つ
導入手順
Vscodeで拡張機能「Python Docstring Generator」をインストールする
https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring
使用方法
- 関数宣言の直下で"""を入力すると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)以上です
まとめ
いかがでしたでしょうか。本記事では、VSCodeでPythonのdocstringを自動生成できる拡張機能「Python Docstring Generator」について紹介しています。ぜひ参考にしてみてください