bantya / vscode-php-docblocker

Simple docblocker for php

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

PHP DocBlocker

Latest Release Installs Rating Build status Coverage status

Basic PHP DocBlocking extension.

We now have a set of unit tests and some full coverage on the parsing of signatures as well as continuous integration. This should ensure the extension remains stable as development progresses.

Features

  • Completion snippet after /** above a class, function, class property
  • Continuation of DocBlock when pressing enter when in a DocBlock
  • Completion of DocBlock tags such as @param, @return, @throws
  • Inferring of param and return types from signatures

Requirements

This extension has no dependencies.

Extension Settings

This extension contributes the following settings:

  • php-docblocker.gap: set to false to disable the gap between the description and tags
  • php-docblocker.extra: an array of extra tags to add to each DocBlock
  • php-docblocker.useShortNames: Wether we should use short type names. e.g. bool or boolean

Future development

It probably wouldn't be too much work to expand this to work with multiple languages. If this is something you are interested in, please pop over to github and add your feedback to the issue neild3r/vscode-php-docblocker#17.

Please also feel free to suggest new configuration options, I appreciate at this time the extension is mostly set up for my own DocBlock style requirements but more options could be added for other use cases.

About

Simple docblocker for php

License:MIT License


Languages

Language:TypeScript 100.0%