配置vim在源码中F4/自动添加作者信息

2023-11-04 09:32

本文主要是介绍配置vim在源码中F4/自动添加作者信息,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!


按F4添加作者信息

每个程序员都有自己心爱的代码编辑和查看工具,相信不少Linux下的程序员都喜欢用Vim,尽管Vim没有SourceInsight这种依托于桌面环境的编辑器看起来那样强大,但是Vim的高效、简洁以及强大的可配置性都让它吸引了无数忠实的fans。

很多编辑器都支持在源代码中自动添加作者信息的功能,SourceInsight就有这项功能。Vim默认是没有这个功能,但是只要我们稍作配置,就可以实现这个功能了。

在Linux下我们需要修改Vim的配置文件vimrc,位于: /etc/vim/vimrc

在window下Vim的配置文件位于安装目录下的_vimrc

然后在配置文件中添加如下信息,就可以实现在源代码中自动添加作者信息了:

"将键盘上的F4功能键映射为添加作者信息的快捷键
map <F4> ms:call TitleDet()<cr>'s
function AddTitle()call append(0,"/*******************************************************************************")call append(1," * Author	 : xxx | work at xxx.")call append(2," * Email	 : xxx@xxx.com")call append(3," * Last modified : ".strftime("%Y-%m-%d %H:%M"))call append(4," * Filename	 : ".expand("%:t"))call append(5," * Description	 : ")call append(6," * *****************************************************************************/")echohl WarningMsg | echo "Successful in adding the copyright." | echohl None
endf"更新最近修改时间和文件名
function UpdateTitle()normal m'execute '/# *Last modified:/s@:.*$@\=strftime(":\t%Y-%m-%d %H:%M")@'normal "normal mkexecute '/# *Filename:/s@:.*$@\=":\t\t".expand("%:t")@'execute "noh"normal 'kechohl WarningMsg | echo "Successful in updating the copy right."| echohl None
endfunction"判断前10行代码里面,是否有Last modified这个单词,
"如果没有的话,代表没有添加过作者信息,需要新添加;
"如果有的话,那么只需要更新即可
function TitleDet()let n=1while n < 10let line = getline(n)if line =~'^\#\s*\S*Last\smodified:\S*.*$'call UpdateTitle()returnendiflet n = n + 1endwhilecall AddTitle()
endfunction



vim自动添加代码作者信息以及自动更新Last Changed时间2012-07-28 02:11 | (分类:vim)


所谓的作者信息和Last Changed时间,一般是这样的:

我们希望实现:

(1)每次新建一个代码文件(C/C++、perl、sh脚本等)时,vim能自动插入这些作者信息到文件头部,包括该文件的创建时间,且光标自动定位到Description处且切换到了Insert模式,等待作者插入代码的描述信息;

(2)每次修改这个文件后,要求VIM能自动更新Last Changed的时间。

 

这两项功能都要依靠VIM的插件来实现。所有提到的插件都可以在这里找到:

http://www.vim.org

(1)为实现第一个功能,下载3个插件: c-support.vim,perl-support.vim,bash-support.vim。

插件不用安装,按说明把它们放入~/.vim/下相应目录即可,没有的目录一律新建。这3个插件分别能对C/C++、perl和shell脚本自动添加作者信息。进入它们各自的templates/Template文件,修改为你的相应信息即可。新建一个cpp或脚本文件,你会发现VIM已经能贴心地替你添加作者信息了 +_+ 也能自动记录文件创建时间。

如果你对以上插件自动给的排版不满意,以c-support.vim为例,你也可以修改~/.vim/c-support/templates/c.comments.template,找到第一个关键字"start"的代码行位置,这里你会看到作者信息的模板,任你DIY以得到任何你想要的排版顺序。perl、sh的插件也是到它们相似的目录下去修改各自的comments文件,而C++还需要修改第二个"start"出现的代码段,那是.h头文件的作者信息模板。

(2)上面3个插件很nice,但唯一的遗憾是不能更新每次修改代码的时间,那么这个作者信息对程序员的价值就要大打折扣了。稍候片刻,再添另一个插件,效果包您满意。这就是TimeStamp.vim。依葫芦画瓢同样把它放入正确目录,然后把下面3行放入你的~/.vimrc文件:

let timestamp_regexp = '\v\C%(<Last %([cC]hanged?|[Mm]odified):\s+)@<=.*$'

set modelines=20   

let g:timestamp_rep = '%m/%d/%Y %X'

最后如(1)一样打开那3大插件各自的comments文件:删除Revised一行,添加一行:

Last Changed: TIMESTAMP

或者

Last Modified: TIMESTAMP

这时你再新建一个源码文件,会发现作者信息里有TIMESTAMP这一行了。当你输入:w保存这个新文件时,TIMESTAMP唰地一下就变成了你保存的时间,再多:w几下,看着那不断刷新的Last Changed时间,幸福感有木有 :-)

 

附注:

TimeStamp.vim默认的是搜索一个源码文件前5行,发现TIMESTAMP这个标签就把它替换成当前系统时间。这是第一次保存时更新时间的机制。此插件另一个默认机制是每当你保存时,搜索前5行,发现有关键字Last Changed(或Last Modified)且后面紧跟一个时间,就会把这个时间替换为当前时间。这是第二次及以后每次保存时更新时间的机制。

所以,你也可以DIY这一部分,如这个命令

let timestamp_regexp = '\v\C%(<Last %([cC]hanged?|[Mm]odified):\s+)@<=.*$'

就能更改第二种机制所要搜索的关键字。这个命令

set modelines=20

则可以设置在多少行的范围内搜索。最后这个命令

let g:timestamp_rep = '%m/%d/%Y %X'

是设置输出时间的格式,分别是月、日、年和12小时制的时间。(还有%y两位数年份、%a星期、%b英文月份、%z时区、%T二十四小时制时间等)。

 

附注2:

一个在vim打开的文件中一键插入当前时间的方法

把以下2行放入你的~/.vimrc文件即可:

:nnoremap <F5> "=strftime("%m/%d/%Y %X")<CR>gP
:inoremap <F5> <C-R>=strftime("%m/%d/%Y %X")<CR>以后只要在vim的normal模式或insert模式下,按下F5,就会插入当前时间。同理,你也可以修改时间格式。strftime也就是timestamp.vim这个插件更新时间所用的函数,它是Unix系统的一个专用于把系统时间信息转换成规范格式的字符串的内建函数。

这篇关于配置vim在源码中F4/自动添加作者信息的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/344850

相关文章

IDEA中配置Tomcat全过程

《IDEA中配置Tomcat全过程》文章介绍了在IDEA中配置Tomcat的六步流程,包括添加服务器、配置部署选项、设置应用服务器及启动,并提及Maven依赖可能因约定大于配置导致问题,需检查依赖版本... 目录第一步第二步第三步第四步第五步第六步总结第一步选择这个方框第二步选择+号,找到Tomca

Win10安装Maven与环境变量配置过程

《Win10安装Maven与环境变量配置过程》本文介绍Maven的安装与配置方法,涵盖下载、环境变量设置、本地仓库及镜像配置,指导如何在IDEA中正确配置Maven,适用于Java及其他语言项目的构建... 目录Maven 是什么?一、下载二、安装三、配置环境四、验证测试五、配置本地仓库六、配置国内镜像地址

Python使用Tenacity一行代码实现自动重试详解

《Python使用Tenacity一行代码实现自动重试详解》tenacity是一个专为Python设计的通用重试库,它的核心理念就是用简单、清晰的方式,为任何可能失败的操作添加重试能力,下面我们就来看... 目录一切始于一个简单的 API 调用Tenacity 入门:一行代码实现优雅重试精细控制:让重试按我

SpringBoot多环境配置数据读取方式

《SpringBoot多环境配置数据读取方式》SpringBoot通过环境隔离机制,支持properties/yaml/yml多格式配置,结合@Value、Environment和@Configura... 目录一、多环境配置的核心思路二、3种配置文件格式详解2.1 properties格式(传统格式)1.

SQL Server跟踪自动统计信息更新实战指南

《SQLServer跟踪自动统计信息更新实战指南》本文详解SQLServer自动统计信息更新的跟踪方法,推荐使用扩展事件实时捕获更新操作及详细信息,同时结合系统视图快速检查统计信息状态,重点强调修... 目录SQL Server 如何跟踪自动统计信息更新:深入解析与实战指南 核心跟踪方法1️⃣ 利用系统目录

Debian系和Redhat系防火墙配置方式

《Debian系和Redhat系防火墙配置方式》文章对比了Debian系UFW和Redhat系Firewalld防火墙的安装、启用禁用、端口管理、规则查看及注意事项,强调SSH端口需开放、规则持久化,... 目录Debian系UFW防火墙1. 安装2. 启用与禁用3. 基本命令4. 注意事项5. 示例配置R

Spring Security 单点登录与自动登录机制的实现原理

《SpringSecurity单点登录与自动登录机制的实现原理》本文探讨SpringSecurity实现单点登录(SSO)与自动登录机制,涵盖JWT跨系统认证、RememberMe持久化Token... 目录一、核心概念解析1.1 单点登录(SSO)1.2 自动登录(Remember Me)二、代码分析三、

PyCharm中配置PyQt的实现步骤

《PyCharm中配置PyQt的实现步骤》PyCharm是JetBrains推出的一款强大的PythonIDE,结合PyQt可以进行pythion高效开发桌面GUI应用程序,本文就来介绍一下PyCha... 目录1. 安装China编程PyQt1.PyQt 核心组件2. 基础 PyQt 应用程序结构3. 使用 Q

Redis MCP 安装与配置指南

《RedisMCP安装与配置指南》本文将详细介绍如何安装和配置RedisMCP,包括快速启动、源码安装、Docker安装、以及相关的配置参数和环境变量设置,感兴趣的朋友一起看看吧... 目录一、Redis MCP 简介二、安www.chinasem.cn装 Redis MCP 服务2.1 快速启动(推荐)2.

MyBatis-Plus 自动赋值实体字段最佳实践指南

《MyBatis-Plus自动赋值实体字段最佳实践指南》MyBatis-Plus通过@TableField注解与填充策略,实现时间戳、用户信息、逻辑删除等字段的自动填充,减少手动赋值,提升开发效率与... 目录1. MyBATis-Plus 自动赋值概述1.1 适用场景1.2 自动填充的原理1.3 填充策略