{"repo":"kkoomen/vim-doge","free":true,"listed":false,"github":"https://github.com/kkoomen/vim-doge","clone":"git clone https://github.com/kkoomen/vim-doge.git","description":"(Do)cumentation (Ge)nerator for nearly 20 languages 📚 Generate proper code documentation with a single keypress. ⚡️🔥","language":"Rust","stars":1058,"topics":["vim","doge","documentation","generator","skeleton","boilerplate","instant","neovim","fast","languages"],"license":"GPL-3.0","category":"docs-static-sites","readme_excerpt":"Any fool can write code that a computer can understand. Good programmers write code that humans can understand. -- Martin Fowler, 1999 We all love documentation because it makes our codebases easier to understand, yet no one has time to write it in a good and proper way. Vim-doge is a (Do)cumentation (Ge)nerator which will generate a proper documentation skeleton based on certain expressions (mainly functions). Simply put your cursor on a function, press d , jump quickly through TODO items using and to quickly add descriptions and go on coding! Table of Contents - Table of Contents - Supported languages and doc standards - Getting started - Configuration Choosing a different doc standard Options + g:doge install path + g:doge enable mappings + g:doge mapping + g:doge filetype aliases + g:doge buffer mappings + g:doge mapping comment jump forward + g:doge mapping comment jump backward + g:doge comment interactive + g:doge comment jump wrap + g:doge comment jump modes - Commands + :DogeGenerate {doc standard} - Language-specific configuration + JavaScript + PHP + Python + Doxygen - Headless mode - Help - Contributing Tree sitter - Development + Environment setup + Helper + Testing locally - Motivation - Supporting vim-doge - Alternative projects - License Supported languages and doc standards Every language that has a documentation standard should be supported by vim-doge. Is your favorite language not supported? [Suggest a new language][suggest-language] :tada: Is your favorit","default_branch":null,"files":null,"tree":[],"storefront":"/r/kkoomen","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/kkoomen/vim-doge/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}