Vim plugin
- Toggle comment/uncomment one or multiple lines of code at a time by pressing
T. - Recognizes your filetype and will comment/uncomment according to that syntax. Added support for most languages that Vim doesn't. Works for languages with double-ended comment strings. (Ex:
<!-- some html stuff -->). - Automatically creates headers (name & today's date) at the top of any new document you create, or any empty document that you open, with proper comment syntax based on your filetype.
- Lets you toggle the current file's header on/off with a single keypress, without disrupting your code, and without moving your cursor from its relative position.
- As soon as you write/save a file that HAS been modified, the header (if one exists) will be updated with the current date.
- The header format is fully customizeable, including the format of the current date. If you change the date format in your vimrc, the old dates in your previous files will automatically update with the new format once you save/write to them again.
- If using Plug as your plugin manager, paste into the plugin section of your
vimrc:
Plug 'ryayoung/vim-annotate-me'- Run
:PlugInstallafter saving and re-opening Vim.
- Declare your name in
vimrc: (this will be used in headers)
let g:my_name = "Your Name"- Commented Text: Toggle using
Tin normal or visual mode, on one or multiple lines. - Display Header: Toggle using
<Leader>T. If you haven't set leader key yet, use\T.
- When you press your shortcut key, the plugin will detect whether the line is commented out, and add/remove the comment character(s) from the beginning of the line and the end of the line if necessary.
- If you're in visual mode and have multiple lines selected, this action will be repeated for each line INDIVIDUALLY, so comment syntax will be inserted for each line in your selection that's not yet commented out, and it will be removed for each line in your section that is already commented out.
- A header will be automatically inserted when you a.) create and give a name to a new file inside vim, or b.) open a completely empty file.
- Header date will auto-update when you save/write to a file that has been modified.
- When toggling the header on/off and auto-updating date, your cursor will maintain its relative position.
let g:auto_header = 0let g:auto_update_date = 0let g:headerstr_name = "Maintainer: "let g:headerstr_time = "Last Modified: "let g:time_fmt = '%b %d, %Y'- Other date formats:
'%Y-%m-%d','%m-%d-%Y','%m/%d/%y', etc.
Don't want to give up Vim's built-in T function? Paste the following into vimrc to use <C-C> (Ctrl-c) instead.
" Comment in normal mode
nnoremap <silent> <C-c> :call ToggleComment()<CR>
" Comment in visual mode
vnoremap <silent> <C-c> :call ToggleComment()<CR>gv
" Toggle header in normal mode
nnoremap <silent> <Leader>z :call ToggleHeader()<CR>Here is what a newly created file will look like in a few different languages:
- Python:
:new example.py
# Maintainer: Ryan Young
# Last Modified: Nov 09, 2021- PHP:
:new example.php
<?php
// Maintainer: Ryan Young
// Last Modified: Nov 09, 2021
?>- HTML:
:new example.html
<!-- Maintainer: Ryan Young -->
<!-- Last Modified: Nov 09, 2021 -->
<!DOCTYPE html>
<html lang="en-US">
<head>
<link rel="stylesheet" href="">
<script src="" async></script>
<meta charset="utf-8">
</head>
<body>
</body>
</html>- Languages which require indentations in front of comments, such as COBOL, are not fully supported: You'll still have the same functionality, but the required indents will NOT be inserted for you.