【VS Code】Visual Studio Code ～ autoDocstring ～

VS Code

■ はじめに

https://dk521123.hatenablog.com/entry/2020/10/10/000000

の続き。autoDocstring を分冊。

目次

【１】autoDocstring
【２】実行方法
【３】Googleスタイルに変更するには
【４】トラブル
　１）エラー「no such file or directory, open 'google.mustache'」が表示

【１】autoDocstring

* Pythonの docstring をサポートする機能

なお、「docstring」について、以下の関連記事を参照のこと。

Python ～ 基本編 / コメント文 ～
https://dk521123.hatenablog.com/entry/2019/10/23/212149

【２】実行方法

『［Ctrl］＋［Shift］＋［2］キー』押下で
コメントのフォーマットを自動生成する

https://www.atmarkit.co.jp/ait/articles/1806/19/news026.html#autodocstring

【３】Googleスタイルに変更するには

https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring

の「Custom Docstring Templates」に記載されている。

[1] 以下の サイトから対象のスタイルをダウンロードする

https://github.com/NilsJPWerner/autoDocstring/tree/master/src/docstring/templates

[2] VS code の「Ctrl + ","キー」押下
[3] 検索欄に「customTemplatePath」を入力
[4] 「Auto Docstring: Custom Template Path」の入力欄に
      [1]でダウンロードしたファイルのフルパスを入力する

【４】トラブル

１）エラー「no such file or directory, open 'google.mustache'」が表示

* autoDocstring を実行したが、以下の「エラー表示」が表示されてしまった
* 再インストール（Uninstall ＆install）しても、同じ結果

エラー表示 

[ERROR 17:08:55.347] Error: ENOENT: no such file or directory, open 'C:\Users\User\Documents\Python Scripts\.vscode\google.mustache'
    at getCustomTemplate <autoDocstring>/out/docstring/get_template.js:17:34
    at AutoDocstring.getTemplate <autoDocstring>/out/generate_docstring.js:56:53
    at AutoDocstring.generateDocstringSnippet <autoDocstring>/out/generate_docstring.js:35:80
    at AutoDocstring.generateDocstring <autoDocstring>/out/generate_docstring.js:23:39
    at  <autoDocstring>/out/extension.js:16:34

原因 

* 'C:\Users\User\Documents\Python Scripts\.vscode\google.mustache' が存在しない
 => 'C:\Users\User\Documents\'からごっそりなかった

解決案 

* 以下から「google.mustache」をダウンロードし、
　'C:\Users\User\Documents\Python Scripts\.vscode\google.mustache' に配置

https://github.com/NilsJPWerner/autoDocstring/blob/master/src/docstring/templates/google.mustache

関連記事

Visual Studio Code ～ 入門編 ～
https://dk521123.hatenablog.com/entry/2019/10/20/230323
Visual Studio Code ～ Python拡張 ～
https://dk521123.hatenablog.com/entry/2020/10/10/000000
Python ～ 基本編 / コメント文 ～
https://dk521123.hatenablog.com/entry/2019/10/23/212149