Pydocstring - Python

能夠自動生成函數(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ù)和返回值的類型

相關(guān)文檔:https://python3-cookbook.readthedocs.io/zh_CN/latest/c07/p03_attach_informatinal_matadata_to_function_arguments.html

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市胸蛛,隨后出現(xiàn)的幾起案子污茵,更是在濱河造成了極大的恐慌,老刑警劉巖葬项,帶你破解...
    沈念sama閱讀 216,496評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件泞当,死亡現(xiàn)場離奇詭異,居然都是意外死亡民珍,警方通過查閱死者的電腦和手機(jī)襟士,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,407評論 3 392
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來嚷量,“玉大人陋桂,你說我怎么就攤上這事〉埽” “怎么了嗜历?”我有些...
    開封第一講書人閱讀 162,632評論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長抖所。 經(jīng)常有香客問我梨州,道長,這世上最難降的妖魔是什么田轧? 我笑而不...
    開封第一講書人閱讀 58,180評論 1 292
  • 正文 為了忘掉前任摊唇,我火速辦了婚禮,結(jié)果婚禮上涯鲁,老公的妹妹穿的比我還像新娘巷查。我一直安慰自己,他們只是感情好抹腿,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,198評論 6 388
  • 文/花漫 我一把揭開白布岛请。 她就那樣靜靜地躺著,像睡著了一般警绩。 火紅的嫁衣襯著肌膚如雪崇败。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,165評論 1 299
  • 那天肩祥,我揣著相機(jī)與錄音后室,去河邊找鬼。 笑死混狠,一個(gè)胖子當(dāng)著我的面吹牛岸霹,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播将饺,決...
    沈念sama閱讀 40,052評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼贡避,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了予弧?” 一聲冷哼從身側(cè)響起刮吧,我...
    開封第一講書人閱讀 38,910評論 0 274
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎掖蛤,沒想到半個(gè)月后杀捻,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,324評論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡蚓庭,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,542評論 2 332
  • 正文 我和宋清朗相戀三年致讥,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片彪置。...
    茶點(diǎn)故事閱讀 39,711評論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡拄踪,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出拳魁,到底是詐尸還是另有隱情惶桐,我是刑警寧澤,帶...
    沈念sama閱讀 35,424評論 5 343
  • 正文 年R本政府宣布潘懊,位于F島的核電站姚糊,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏授舟。R本人自食惡果不足惜救恨,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,017評論 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望释树。 院中可真熱鬧肠槽,春花似錦擎淤、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,668評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至寂纪,卻和暖如春席吴,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背捞蛋。 一陣腳步聲響...
    開封第一講書人閱讀 32,823評論 1 269
  • 我被黑心中介騙來泰國打工孝冒, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人拟杉。 一個(gè)月前我還...
    沈念sama閱讀 47,722評論 2 368
  • 正文 我出身青樓庄涡,卻偏偏與公主長得像,于是被迫代替她去往敵國和親捣域。 傳聞我的和親對象是個(gè)殘疾皇子啼染,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,611評論 2 353

推薦閱讀更多精彩內(nèi)容

  • [TOC] 前言 記得在剛學(xué) Vim[https://github.com/vim/vim] 的時(shí)候,就把 《Vi...
    Whyn閱讀 1,082評論 0 0
  • vim在開發(fā)中十分高效焕梅,但是vim的默認(rèn)的樣式卻很不友好迹鹅,接下來我們將一下如何美化和配置vim,本文是基于MacO...
    troublemak_19be閱讀 6,307評論 1 17
  • 這篇文章是手冊的中文譯版整理而來(英文看著太慢了贞言,感謝前人鋪路Orz...)斜棚,vim的markdown插件和實(shí)時(shí)預(yù)...
    Himryang閱讀 6,990評論 0 20
  • 都知道vim具有高度的可配置性,雖然有大神說過原生的vim可以做插件提供的90%的功能该窗,但是那也是需要一定的境界弟蚀,...
    為夢澆水閱讀 7,781評論 0 7
  • 這些天,一直在反思一個(gè)問題:就是你看起來那么努力酗失,可是义钉,你到底學(xué)到了什么?你看起來時(shí)間排得那么滿滿规肴,卻為什么還是那...
    木華益閱讀 11,562評論 0 6