PHP, JS: Code Dokumentation

Diese PHP-Dokumentation, welche der Einfachheit halber auch für JavaScript verwendet werden kann, basiert auf PHPDoc¹.

/**
 * File documentation
 *
 * Description
 *
 * @category    # Used to organize groups of packages together. #
 * @package     # Can only be used to document procedural pages or classes. #
 * @author      Patric Eberle 
 * @copyright   Copyright (c) 2013, gyselroth GmbH 
 * @version     # Documents the version of any element, including a page-level block #
 * @license     # http://www.gnu.org/copyleft/gpl.html GNU GPL v3 #
 */

/**
 * Class/Function documentation
 *
 * @param       # int, string, bool, array, ... # # variable name #
 * @return      # void, mixed, int|string|false|true|array # # description #
 */

1. http://manual.phpdoc.org [↩]