https://github.com/condy0919/docom.vim

A comment documentation highlighting plugin for c/cpp
https://github.com/condy0919/docom.vim

document highlight neovim plugin vim

Last synced: 3 months ago
JSON representation

A comment documentation highlighting plugin for c/cpp

• Host: GitHub
• URL: https://github.com/condy0919/docom.vim
• Owner: condy0919
• Created: 2019-10-07T13:21:19.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-05-21T19:37:59.000Z (over 4 years ago)
• Last Synced: 2024-06-10T02:31:21.563Z (5 months ago)
• Topics: document, highlight, neovim, plugin, vim
• Language: Vim script
• Homepage:
• Size: 112 KB
• Stars: 9
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
docom.vim

========

A comment doc highlighting plugin for C/Cpp, inspired by [rust.vim](https://github.com/rust-lang/rust.vim/).

# Installation

Use [plug](https://github.com/junegunn/vim-plug) to manage dependencies.

```bash

Plug 'condy0919/docom.vim'

```

# Screenshots

![docom vs raw](https://raw.githubusercontent.com/condy0919/docom.vim/master/static/docom_vs_raw.png)

docom VS raw

![docom vs doxygen](https://raw.githubusercontent.com/condy0919/docom.vim/master/static/docom_vs_doxygen.png)

docom VS doxygen

PS: the vim theme is [onedark](https://github.com/joshdick/onedark.vim)

# TODO

- [x] automatically insert comments and format for `///` and `//!`

# Contribution

PR welcome.