能夠自動生成函數(shù)文檔注釋淌哟、類文檔注釋土涝,包含以下功能验庙。
插入一行文檔字符串
插入多行文檔字符串
原倉庫地址:https://github.com/heavenshell/vim-pydocstring
效果圖:https://github.com/heavenshell/vim-pydocstring/blob/master/assets/vim-pydocstring.gif
用法
將光標(biāo)移動到 def 或 class 關(guān)鍵字所在行袜刷,按下 ctrl + l 或在命令行輸入Pydocstring议经, 就可以看到文檔字符串模板神奇地出現(xiàn)在當(dāng)前行下方横堡。
設(shè)置
Pydocstring 的縮進(jìn)取決于 softtabstop 值埋市。你需要給 vim 配置這樣的語句 set softtabstop=4。
例 .vimrc 中輸入
autocmd FileType python setlocal tabstop = 4 shiftwidth = 4 softtabstop = 4 expandtab
關(guān)鍵映射
如果要更改默認(rèn)鍵映射命贴,請?jiān)?vimrc中設(shè)置以下內(nèi)容道宅。
nmap <silent> <C-_> <Plug>(pydocstring)
函數(shù)文檔效果圖
生成效果圖
指定參數(shù)和返回值的類型