You're here: Home » Vim
» phpdoc.vim
phpdoc.vim plugin
This is a modified version of the original work done by Karl Heinz
Marbaise whose plugin can be found at the Vim script repository.
To my knowledge his version is not maintained anymore and for me it
had some shortcomings so I took it and improved it for my needs.
Download
phpdoc.vim plugin. This version was last
updated on 15th of January 2008.
Installation/Configuration
Simply place it in your plugin/ directory. The plugin is
automatically activated and upon writing PHP code, it automatically
generates phpdoc compatible
comments in your code for classes, interfaces, functions and
properties.
Changes
The most notable changes are listed here only. For the details
consult the plugin itself, it has a pretty detailed changelog included
in the header.
Most notable changes/improvements:
- Seamless integration when you write code: just write your
function definition, you won't be interrupted anymore.
- Automatically generate phpdoc comments for all function
parameters, including type hints and support documenting of default
and optional values as well as properties. Also support function
definitions spanning multiple lines (see
g:phpdoc_BackLineEval).
- Support a pretty flexible way of providing your own phpdoc lines
to what is generates. E.g. you can add your own @author tag
to all classes automatically created. Custom tags can be added to
interfaces/classes, functions and properties.
- Concentrate on PHP5 and later, don't generate @access, @static,
@final, etc. phpdoc is very well capable of figuring this out
itself.
Contact me