找回密码
 立即注册
搜索
热搜: 活动 交友 discuz
查看: 516|回复: 1

如何编写规范的工程代码之 VIM自定义快捷键和添加注释

[复制链接]

205

主题

172

回帖

6921

积分

论坛元老

积分
6921
发表于 2013-6-12 20:12:50 | 显示全部楼层 |阅读模式
如何编写规范的工程代码之VIM定义快捷键和添加注释


1. 获取DoxygenToolkit.vim插件[blockquote]
下载地址:http://www.vim.org/scripts/script.php?script_id=987
将其拷贝到如下目录:
Linux版本是CentOS6.4的版本路径:/usr/share/vim/vim72/plugin/
Ubuntu系统路径:/usr/share/vim/vim73/plugin[/blockquote]
2. 自定义快捷键[blockquote]
修改配置文件:/etc/vimrc
"自动排版
map <F8> gg=G
"插入块注释   /*  */
vmap <F9> dO*/<Esc>O/*<Esc>
"插入条件编译注释
vmap <F10> dO#endif<Esc>O#if 0<Esc>
"F11自动在当前位置插入日期
map <F11> i<C-R>=strftime("%Y-%m-%d %H:%M:%S")<CR><Esc>
"添加函数头注释
map <F12> <Esc>ox<cr>[/blockquote]

3. VIM的快捷操作[blockquote]
1) F8:自动排版  
用法:命令模式下(按下ESC,下同)直接按F8,将完成整个代码的排版,按C/C++缩进风格缩进。
2) F9:插入块注释
用法:命令模式下,按v键,选择要注释的部分,按下F9插入块注释,即 /*内容*/
3) F10:插入条件编译注释
用法:命令模式下,按v键,选择要注释的部分,按下F9插入编译注释,即#if 0 内容#endif
4) F11:自动在光标当前位置插入日期
用法:命令模式下,按F11
5) F12:添加函数头注释
用法:命令模式下,在函数的第一行按下F12[/blockquote]
4. VIM配置
4.1. 配置自动缩进[blockquote]
"设置C自动缩进,缩进4个字节
set cindent shiftwidth=4   
"设置TAB缩进为4个字节
set tabstop=4
set expandtab
"设置命令模式下按SHIFT缩进为4个字节
set softtabstop=4
set shiftwidth=4[/blockquote]
4.2. 自动添加.c .cpp .h文件注释[blockquote]
配置路径:每个用户目录下创建一个.vimrc文件(例如/home/chenqin/),内容如下:
func SetComment()
call setline(1,"/**************************************************************")
call append(line("."), "* Copyright (C) 2006-".strftime("%Y")." All rights reserved.")
call append(2,"* @Version: 1.0")
call append(3,"* @Created: " . strftime("%Y-%m-%d %H:%M"))
call append(4,"* @Author: chenqin - chenqin@infogo.com.cn")
call append(5,"* @Description: ")
call append(6,"*")
call append(7,"* @History: ")
call append(8,"**************************************************************/")
endfunc
func Setifdef()
call setline(1,"/**************************************************************")
call append(line("."), "* Copyright (C) 2006-".strftime("%Y")." All rights reserved.")
call append(2,"* @Version: 1.0")
call append(3,"* @Created: " . strftime("%Y-%m-%d %H:%M"))
call append(4,"* @Author: chenqin - chenqin@infogo.com.cn")
call append(5,"* @Description: ")
call append(6,"*")
call append(7,"* @History: ")
call append(8,"**************************************************************/")
call append(9,"#ifndef")
call append(10, "#define")
call append(11, "")
call append(12, "")
call append(13, "#endif")
endfunc
autocmd BufNewFile *.c,*.cpp exec ":call SetComment()"
autocmd BufNewFile *.h exec ":call Setifdef()"
Author:可以修改成自己的名字
修改/etc/vimrc配置如下:
"let goxygenToolkit_briefTag_pre="@Name: "
let goxygenToolkit_paramTag_pre="@Param: "
let goxygenToolkit_returnTag ="Returns: "
"letgoxygenToolkit_blockHeader="/*******************************************************"
"let goxygenToolkit_blockFooter="*******************************************************/"
"let goxygenToolkit_authorName="chenqin,chenqin@infogo.com.cn"
let goxygenToolkit_licenseTag="Copyright (C) Infogo Technology LimitedCompany"
let goxygenToolkit_briefTag_funcName="yes"
let g:doxygen_enhanced_color=1
[/blockquote]

4.3. 效果展示[blockquote]由于我在vim配置文件中设置了快捷键,在使用过程中我只需要在把光标定位到函数第一行按下F12就可以在函数前自动生成注释了。赋图一张,图(一)[/blockquote][blockquote]
[/blockquote]
file:///C:\Users\ADMINI~1\AppData\Local\Temp\ksohtml\wps_clip_image-14011.png

下载地址:视频下载地址
提取码:1669


0

主题

58

回帖

0

积分

新手上路

积分
0
发表于 2013-9-17 18:42:14 | 显示全部楼层
这个也是不行的啊。不能下载啊,楼主补一下吧。
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

果子博客
扫码关注微信公众号

Archiver|手机版|小黑屋|风叶林

GMT+8, 2026-2-1 04:40 , Processed in 0.139366 second(s), 20 queries .

Powered by 风叶林

© 2001-2026 Discuz! Team.

快速回复 返回顶部 返回列表