https://github.com/sublimetext/phpdoc
PhpDoc support package.
https://github.com/sublimetext/phpdoc
Last synced: 10 months ago
JSON representation
PhpDoc support package.
- Host: GitHub
- URL: https://github.com/sublimetext/phpdoc
- Owner: SublimeText
- Created: 2011-09-27T21:36:49.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2015-12-06T19:56:22.000Z (about 10 years ago)
- Last Synced: 2025-04-15T21:17:04.143Z (10 months ago)
- Language: JavaScript
- Homepage:
- Size: 16.6 KB
- Stars: 165
- Watchers: 16
- Forks: 21
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
#PHPDoc
CodeDoc is a Sublime Text 2/3 plugin to speedup writing documenting comments.
Currently, [PhpDoc](http://phpdoc.org/) for PHP is supported, therefore CodeDoc is renamed to PhpDoc until support of other documentation types is added (if ever).
To use, just type in `/**` on the line right before class or function declaration, and then invoke auto-completion (with e.g. ctrl+space). This will get you a template for starters, with some values pre-filled on the fly (such as function arguments list). All common documenting keys are also available for manual input.
On some systems you have to fiddle a bit to find the auto-completion key. If it's not working on your system, just type `/**` and choose Edit->Show Completions. In the menu, in front of the item it will be the key combination for the auto-completion (e.g. ctrl+space, alt+/, etc)