返回首頁
當前位置: 主頁 > 網絡編程 > Jsp實例教程 >

vim 自動添加文件注解(針對php和js文件)

時間:2013-10-30 22:48來源:知行網www.wtckvq.live 編輯:麥田守望者

我們在開始一個新的項目的時候總想對所有的文件加一點注釋信息,例如版權呀,作者呀,文件創建的時間呀等等。那么用VIM 是怎么做到的呢?

修改.vimrc文件

首先需要修改下vimrc的配置文件,讓vim 在創建新文件的時候自動補齊那些信息。添加的部分如下:

autocmd BufNewFile *.php,*.js exec ":call SetComment()"

func SetComment()
        if expand("%:e") == 'php'
                call setline(1,"<?php")
        elseif expand("%:e") == 'js'
                call setline(1,"// JavaScript file")
        endif
        call append(line("."),   "/*")
        call append(line(".")+1,   "  +----------------------------------------------------------------------+")
        call append(line(".")+2, "  | LazyApiDoc                                                           |")
        call append(line(".")+3, "  +----------------------------------------------------------------------+")
        call append(line(".")+4, "  | LazyApiDoc is a tool for restful interface document manager.         |")
        call append(line(".")+5, "  | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )              |")
        call append(line(".")+6, "  +----------------------------------------------------------------------+")  
        call append(line(".")+7, "  | Author:lazypeople <[email protected]>                              |")
        call append(line(".")+8, "  +----------------------------------------------------------------------+")
        call append(line(".")+9, "*/")
        call append(line(".")+10, " ")
        call append(line(".")+11, "/*".expand("%:t")." ".strftime("%Y/%m/%d %H:%M:%S %Z")." lazypeople*/")  
endfunc

 

主要是autocmd BufNewFile *.php,*.js exec “:call SetComment()”讓vim在創建文件的時候可以知道到底是不是php或者js文件,這個是依賴創建時的后綴名決定的。當然如果你不是php程序員,當然可以按照上述的例子修改成為你的語言,例如.py .c .cpp .pl等等.如果相對所有的文件都加上注解,這個可能不是很好辦,因為不同文件的注解形式是不一樣的,例如你對c語言的注解就無法用在html文件中。

測試

 

[email protected]:~/workspace/lazyapidoc$ vim testAutoCommit.php

可以看到生成的文件:

  1 <?php                                                                          
  2 /*                                                                              
  3   +----------------------------------------------------------------------+      
  4   | LazyApiDoc                                                           |      
  5   +----------------------------------------------------------------------+      
  6   | LazyApiDoc is a tool for restful interface document manager.         |      
  7   | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )              |      
  8   +----------------------------------------------------------------------+      
  9   | Author:lazypeople <[email protected]>                              |      
 10   +----------------------------------------------------------------------+      
 11 */
                                                                             
 12                                                                                
 13 /*testAutoCommit.php 2013/10/11 10:21:11 CST lazypeople*/

 

------分隔線----------------------------
標簽(Tag):jQuery jquery教程 jquery技巧
------分隔線----------------------------
推薦內容
猜你感興趣
深蓝海域APP 做中高端服装赚钱么 ios小鱼赚钱 如何赚钱手工 童装批发店赚钱吗 比特现金币很赚钱吗 蛇怎么赚钱 红地毯生意赚钱吗 大空头怎么赚钱 手机直播怎样刷屏赚钱 fifa14手机经理模式赚钱 工地上有哪些赚钱办法 刷什么游戏可以赚钱 开理发店不赚钱怎么办 dnf2018还能赚钱吗 手机挂机也能赚钱的软件吗 2018网上收徒赚钱软件