[Feature request] File header docblock

[wutianjun5858]

Can vim-doge create a file header? Does the file header contain author or even license? There are also typedef structures, etc.

[kkoomen]

Hi,

Well, at first I'd say that this plugin simply does expressions, such as functions, classes, class properties etc, but I think it is an interesting idea. I do can make a command like DogeInsertBanner that inserts a file header at the top of the file (depending on the syntax per language and standards within that language), like so:

/**
 * <FILENAME>
 *
 * [TODO:description]
 *
 * @author     <NAME>
 * @copyright  <YEAR> <NAME>
 * @license    [TODO:license name]
 */

Then the user can configure certain properties in their vimrc:

" <NAME> replacement
let g:doge_header_name = "John Doe <[email protected]>"

Tokens like <YEAR> and <FILENAME> can be generated by vim-doge. The above result would look like this:

/**
 * database.php
 *
 * Contains database helper functions
 *
 * @author     John Doe <[email protected]>
 * @copyright  2023 <[email protected]>
 * @license    MIT
 */

Then, the user can add more by themself if needed. Vim-doge simply provides the skeleton that is according to standards and contains information that are used by most people, so it should only contain the most commonly used info, such as author, copyright, license, name, description.

I can look at this soon, but this does require quite some research for all the languages that are currently provided by vim-doge.