Skip to content

Instantly share code, notes, and snippets.

@ozh
Last active August 29, 2015 14:00
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save ozh/11083650 to your computer and use it in GitHub Desktop.
Save ozh/11083650 to your computer and use it in GitHub Desktop.
PHPdoc block formatting
<?php
/**
* One line description then an empty line
*
* Optional additional description, multiline if needed, with
* code examples, links, anything
*
* Can be separated in multiple paragraphs, as long as there's
* a blank line before the first @tag
*
* @param bool $stuff The first @param must be after a blank line, even if other @tags are used before
* @param string $param_one Descriptions in one line, at least two spaces after the $var name
* @param int $var Other descriptions should be aligned to the rightmost description
* @return array Minimum should be @param and @return tags (if applicable)
*/
... <code> ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment