phpdoc - Best way to write contributions header in php and all available tags like @author -
i working on github project https://github.com/qzoke/isbn-converter want create nice contribution header. here questions :
- all variables or whatever @author available.
few know are:
@author @license @version @package @subpackage - best way showcase values like
few use
@author www.website.com few use
@author name<email> and
@author name. how , should name package , sub package. subpackage confusing , no idea if should use file name in subpackage or same package name.
is ok write description, keyword, contribution in there.
what's best way reference license, name (like gnu gpl v3.0) or name+weblink or link local copy or copy of whole license text.
and files should have such header , index.php , or header.php or every other.
and include in html commenting , if any.
according https://phpdoc.org/ documentation there number of tags recognised phpdocumentor listed @ https://phpdoc.org/docs/latest/index.html.
example source https://phpdoc.org/docs/latest/references/phpdoc/tags/author.html
syntax: @author [name] [<email address>]the @author tag can used indicate has created structural elements or has made significant modifications them. tag may contain e-mail address. if e-mail address provided must follow author’s name , contained in chevrons, or angle brackets, , must adhere syntax defined in section 3.4.1 of rfc5322.
all points can answered using documentation of phpdoc.
few more phpdoc tags :
@abstract @access @author @copyright @deprecated @deprec @example @exception @global @ignore @internal @license @link @name @magic @package @param @return @see @since @static @staticvar @subpackage @throws @todo @var @version you can find more in https://en.wikipedia.org/wiki/phpdoc
Comments
Post a Comment