Pydocstring - Python文檔字符串的生成器

能夠自動生成函數文檔注釋、類文檔注釋，包含以下功能。

• 插入一行文檔字符串
• 插入多行文檔字符串
• 插入評論

這個插件深受 phpdoc.vim和sonictemplate.vim的啟發。

原倉庫地址：https://github.com/heavenshell/vim-pydocstring
效果圖：https://github.com/heavenshell/vim-pydocstring/blob/master/assets/vim-pydocstring.gif

用法

將光標移動到 def 或 class 關鍵字所在行，按下 ctrl + l 或在命令行輸入Pydocstring， 就可以看到文檔字符串模板神奇地出現在當前行下方。

• 設置
  Pydocstring 的縮進取決于 softtabstop 值。你需要給 vim 配置這樣的語句 set softtabstop=4。

例 .vimrc 中輸入

autocmd FileType python setlocal tabstop = 4 shiftwidth = 4 softtabstop = 4 expandtab

關鍵映射

如果要更改默認鍵映射，請在.vimrc中設置以下內容。

nmap (pydocstring)

• 函數文檔效果圖

  
  
  

  生成效果圖
• 指定參數和返回值的類型
  相關文檔: https://python3-cookbook.readthedocs.io/zh_CN/latest/c07/p03_attach_informatinal_matadata_to_function_arguments.html
  
  

  指定類型