phpdoc tags
@abstract Document an abstract class, class variable or method
@access Access control for an element. @access private prevents documentation of the following element (if enabled).
@author Author of current element
@category Specify a category to organize the documented element’s package into
@copyright Document Copyright information
@deprecated Document elements that have been deprecated and should not be used as they may be removed at any time from a future version
@example Include an external example file with syntax highlighting
@final Document a class method that should never be overridden in a child class
@filesource create a syntax-highlighted cross-referenced file containing source code of the current file and link to it
@global Document a global variable, or its use in a function/method
@ignore Prevent documentation of an element
@internal Mark documentation as private, internal to the software project
@license Display a hyperlink to a URL for a license
@link Display a hyperlink to a URL in the documentation
@method “Magic” Method of a class.
@name Specify an alias to use for a procedural page or global variable in displayed documentation and linking
@package Specify package to group classes or functions and defines into
@param Document a function parameter
@property “Magic” Property of a class.
@return Specify the return type of a function or method
@see Display a link to the documentation for an element
@since Document when (at which version) an element was first added to a package
@static Document a static class or method
@staticvar Document a static variable’s use in a function/method
@subpackage Specify sub-package to group classes or functions and defines into. Requires @package tag
@todo Document changes that will be made in the future
@tutorial Display a link to the documentation for a tutorial
@uses Display a link to the documentation for an element, and create a backlink in the other element’s documentation to this
@var Document the data type of a class variable
@version Version of current element
inline tags
inline {@example} Display source code of an example file inline
inline {@id} Used to control XML tutorial ids in refsects
inline {@internal}} Mark documentation as private, internal to the software project in text flow
inline {@inheritdoc} Used to directly inherit the long description from the parent class in child classes
inline {@link} Display a link to a URL, or link to an element’s documentation in the the flow of descriptive text
inline {@source} Display source code of a function or method in the long description
inline {@toc} Display a table of contents of all {@id}s declared in a file
inline {@tutorial} Display a link to a tutorial in the the flow of descriptive text
example
@abstract declare a method, class variable, or class
@access private|protected|public
@author authorname
@category categoryname
@copyright copyright information
@deprecated version/info string
@example /path/to/example.php description
@final
@filesource
@global datatype $globalvariablename
@global datatype description
@ignore
@internal any information that should not be displayed in public documentation [unspecified format]
@license URL name of license
@link URL link text
@link URL, URL, URL…
@method returntype description
@name $globalvariablename
@package packagename
@param datatype $paramname description
@property datatype description
@return datatype description
@see file.ext|elementname|class::methodname()|class::$variablename|functionname()|function functionname unlimited number of values separated by commas
@since version/info string [unspecified format]
@static
@staticvar datatype description
@subpackage subpackagename
@todo information string [unspecified format]
@tutorial package/ subpackage/ tutorialname.ext #section.subsection description
@uses file.ext|elementname|class::methodname()|class::$variablename|functionname()|function functionname description of how the element is used
@var datatype description
@version versionstring [unspecified format]
{@example /path/to/example.php startline number of lines }
{@example url://path/to/example.php startline number of lines }
{@example relative/path/to/example.php startline number of lines }
{@id sectionname }
{@internal any text including inline tags }}
{@inheritdoc}
{@link URL description }
{@link element description }
{@source startline number of lines }
{@toc}
{@tutorial package/ subpackage/ tutorialname.ext #section.subsection description } }
PHPDoc Note
ความเห็น
บทความในวันเดียวกัน
Man In Flame · 12 มิ.ย. 2550
Man In Flame · 12 มิ.ย. 2550
วรรธนชัย ๏(。◕‿◕。)๏ ♫ ♬ ♪ ♩ ♭ · 12 มิ.ย. 2550
Dr.Anongpanuch · 12 มิ.ย. 2550
Man In Flame · 12 มิ.ย. 2550
เทพฤทธิ์ · 12 มิ.ย. 2550
นาง อรสา เสนีวงศ์ ณ อยุธยา · 12 มิ.ย. 2550
อยากให้คุณPatrickz เขียนเรื่องการติดตั้ง PHPDoc
หน่อยครับ ผมใช้งาน บน windows แล้วทดสอบการติดตั้งไม่ได้สักทีครับ
สวัสดีค่ะ
แค่มาเยี่ยมค่ะ ที่คุณสอนๆอยู่นี้ไม่สันทัดค่ะ เลยให้ความเห็นไม่ค่อยได้ รู้แต่ว่า คุณเก่งมากๆค่ะ
อยากให้คุณPatrickz เขียนเรื่องการติดตั้ง PHPDoc
หน่อยครับ ผมใช้งาน บน windows แล้วทดสอบการติดตั้งไม่ได้สักทีครับ
สวัสดีค่ะ
แค่มาเยี่ยมค่ะ ที่คุณสอนๆอยู่นี้ไม่สันทัดค่ะ เลยให้ความเห็นไม่ค่อยได้ รู้แต่ว่า คุณเก่งมากๆค่ะ
ขอบคุณครับ แต่แหม คนเก่งกว่าผมมีอีกเยอะเลยนะครับ
อยากให้คุณPatrickz เขียนเรื่องการติดตั้ง PHPDoc
หน่อยครับ ผมใช้งาน บน windows แล้วทดสอบการติดตั้งไม่ได้สักทีครับ
สวัสดีค่ะ
แค่มาเยี่ยมค่ะ ที่คุณสอนๆอยู่นี้ไม่สันทัดค่ะ เลยให้ความเห็นไม่ค่อยได้ รู้แต่ว่า คุณเก่งมากๆค่ะ
ขอบคุณครับ แต่แหม คนเก่งกว่าผมมีอีกเยอะเลยนะครับ