BETA

VimでPythonのdocstringをいい感じに書きたい

投稿日:2020-05-04
最終更新:2020-05-04

経緯

VimでPythonのコードを書くときに、heavenshell/vim-pydocstringの古いバージョンをずっと使っていましたが、最近になって機能がもの足りないなぁと思いはじめたんですよね。
最近のバージョンだといい感じのようなんですが、私の使っているNeoVimでは動きませんでした…。残念。

結論

色々調べた結果、今はpixelneo/vim-python-docstringを使っています。スターが少ないのですが、期待通りに動いてくれてます。

init.vim(普通のvimでいうところのvimrc)に以下を追加することで、Ctrl + lでdocstringの追加をしています。

nnoremap <silent> <C-l> :Docstring<CR>  

また、デフォルトではGoogleのスタイルなのですが、

let g:python_style = 'numpy'  

のようにして指定できるようです。

他のやりかたは?

SirVer/ultisnipsとhonza/vim-snippetsを使うことで次のようにdocstringをかけます。

こちらも非常に良いのですが、docstringの雛形ができてから中身の実装をしていく感じになるんですよね。実際には関数の実装をしてからdocstringを追加することが多く、そういった使い方をするときにどうすればよいか分からず見送りました…。

技術ブログをはじめよう Qrunch(クランチ)は、プログラマの技術アプトプットに特化したブログサービスです
駆け出しエンジニアからエキスパートまで全ての方々のアウトプットを歓迎しております!
or 外部アカウントで 登録 / ログイン する
クランチについてもっと詳しく

この記事が掲載されているブログ

@opqrstuvcutの技術とか技術以外のブログ 最近フリーランスになりました

よく一緒に読まれる記事

0件のコメント

ブログ開設 or ログイン してコメントを送ってみよう