Vim插件生成Javascript文档注释

发布时间：2020-12-15 22:17:36 所属栏目：安全来源：网络整理

导读：是否有一个 vim插件,有点像Jsbeautify,它会自动生成 JavaDoc,就像脚本文件中的注释一样. 例如,它将采取这一点 function(a,b,c){} 并返回 /** * Description. * * @param a Description. * @param b Description. * @param c Description. */function(a,c){}

是否有一个 vim插件,有点像Jsbeautify,它会自动生成 JavaDoc,就像脚本文件中的注释一样.

例如,它将采取这一点

function(a,b,c){
}

并返回

/**
 * Description.
 *
 * @param a  Description.
 * @param b  Description.
 * @param c  Description.
 */
function(a,c){
}

解决方法

这里有一些让你入门的东西 – 根据需要进行调整！ – )

" generate doc comment template
map <LocalLeader>/ :call GenerateDOCComment()<cr>

function! GenerateDOCComment()
  let l    = line('.')
  let i    = indent(l)
  let pre  = repeat(' ',i)
  let text = getline(l)
  let params   = matchstr(text,'([^)]*)')
  let paramPat = '([$a-zA-Z_0-9]+)[,]*(.*)'
  echomsg params
  let vars = []
  let m    = ' '
  let ml = matchlist(params,paramPat)
  while ml!=[]
    let [_,var;rest]= ml
    let vars += [pre.' * @param '.var]
    let ml = matchlist(rest,paramPat,0)
  endwhile
  let comment = [pre.'/**',pre.' * '] + vars + [pre.' */']
  call append(l-1,comment)
  call cursor(l+1,i+3)
endfunction

假设参数列表在一行上,它会尝试匹配参数,建立注释字符串,并将该注释字符串附加到函数头之前的行.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!