Pydocstring - Python文檔字符串的生成器
能夠自動(dòng)生成函數(shù)文檔注釋、類文檔注釋,包含以下功能。
- 插入一行文檔字符串
- 插入多行文檔字符串
- 插入評(píng)論
這個(gè)插件深受 phpdoc.vim和sonictemplate.vim的啟發(fā)。
原倉(cāng)庫(kù)地址:https://github.com/heavenshell/vim-pydocstring
效果圖:https://github.com/heavenshell/vim-pydocstring/blob/master/assets/vim-pydocstring.gif
用法
將光標(biāo)移動(dòng)到 def 或 class 關(guān)鍵字所在行,按下 ctrl + l 或在命令行輸入Pydocstring, 就可以看到文檔字符串模板神奇地出現(xiàn)在當(dāng)前行下方。
-
設(shè)置
Pydocstring 的縮進(jìn)取決于 softtabstop 值。你需要給 vim 配置這樣的語(yǔ)句 set softtabstop=4。
例 .vimrc 中輸入
autocmd FileType python setlocal tabstop = 4 shiftwidth = 4 softtabstop = 4 expandtab
關(guān)鍵映射
如果要更改默認(rèn)鍵映射,請(qǐng)?jiān)?vimrc中設(shè)置以下內(nèi)容。
nmap
-
函數(shù)文檔效果圖
-
指定參數(shù)和返回值的類型
相關(guān)文檔: https://python3-cookbook.readthedocs.io/zh_CN/latest/c07/p03_attach_informatinal_matadata_to_function_arguments.html
更多文章、技術(shù)交流、商務(wù)合作、聯(lián)系博主
微信掃碼或搜索:z360901061

微信掃一掃加我為好友
QQ號(hào)聯(lián)系: 360901061
您的支持是博主寫作最大的動(dòng)力,如果您喜歡我的文章,感覺我的文章對(duì)您有幫助,請(qǐng)用微信掃描下面二維碼支持博主2元、5元、10元、20元等您想捐的金額吧,狠狠點(diǎn)擊下面給點(diǎn)支持吧,站長(zhǎng)非常感激您!手機(jī)微信長(zhǎng)按不能支付解決辦法:請(qǐng)將微信支付二維碼保存到相冊(cè),切換到微信,然后點(diǎn)擊微信右上角掃一掃功能,選擇支付二維碼完成支付。
【本文對(duì)您有幫助就好】元
