Please refer to Appendix Two for a detailed description of this label.
Here is an example of a document comment
/**
* Function add to achieve two number of additions
*
* A simple addition calculation, the function accepts two numbers A, B, returns their and C
*
* @param int Addend
* @param int Summand
* @return Integer
*/
function Add ($a, $b)
{
return $a + $b;
}
The resulting document is as follows:
Add
Integer ADD (int $a, int $b)
[Line 45]
function Add, implement two number of additions
Constants A simple addition calculation, the function accepts two numbers A, B, returns their and C
Parameters
? int $a-Addend
? int $b-Summand
5. Document Tags:
The use of a document tag is a keyword, or other document tag, that the tag can be used to decorate.
All document tags begin with a * after each line. If the mark of @ is out of the middle of a paragraph, the tag will be ignored as normal content.
@access
Scope of Use: Class,function,var,define,module
The tag is used to indicate access rights for the keyword: private, public, or proteced
@author
Specify the author
@copyright
Scope of Use: Class,function,var,define,module,use
Specify copyright information
@deprecated
Scope of Use: Class,function,var,define,module,constent,global,include
Identify unused or deprecated keywords
@example
This tag is used to parse the contents of a file and highlight them. Phpdoc will attempt to get from this token to the file pathRead FileContent
@const
Scope of Use: Define
Constants used to indicate define in PHP
@final
Scope of Use: Class,function,var
Indicates that the keyword is a final class, method, property, prohibit derivation, modification.
@filesource
Similar to example, except that the tag directly reads and displays the contents of the currently parsed PHP file.
@global
That indicates the reference in this function.Global Variables
@ingore
Used to omit the specified keyword from the document
@license
Equivalent to the HTML tag, first the URL, followed by the content to be displayed
For exampleBaidu
Can write @license http://www.baidu.comBaidu
@link
Similar to license
But you can also refer to any one of the keywords in the document by using link
@name
Specifies an alias for the keyword.
@package
Scope of Use: page-level, define,function,include
Class-Level->class,var,methods
Used to logically divide one or several keywords into a group.
@abstrcut
Indicates that the current class is an abstract class
@param
Indicates the parameters of a function
@return
Indicates that the return of a method or function refers to the
@static
Indicates that the off-build word is static.
@var
Indicate variable type
@version
Specifying version information
@todo
Identify areas that should be improved or not implemented
@throws
Indicates that this function may throw an error exception, which can occur in extreme cases
As mentioned above, ordinary document tag tags must be at the beginning of each line at the @ mark, in addition, there is a tag called inline tag, with {@}, including the following:
{@link}
Usage with @link
{@source}
Show the contents of a function or method
6. Some annotation specifications
A. The comment must be
/**
* XXXXXXX
*/
The form
B. For references to theGlobal Variablesfunction, you must use the glboal tag.
C. For variables, the type must be marked with VAR (int,string,bool ... ）
D. Functions must indicate their arguments and return values through the Param and return tags
E. For keywords that appear two or more times or more than two times, you need to ignore the excess by ingore and keep only one
F. Where other functions or classes are called, use link or other tags to link to the appropriate section for easy document reading.
G. Use non-document annotations where necessary to improve code legibility.
H. Descriptive content as concise as possible, using phrases rather than sentences.
I.Global Variables，Static Variablesand constants must be indicated by corresponding tags
7. Summary
Phpdocumentor is a very powerful document auto-generation tool that helps us write specification annotations, generate easy-to-understand, well-structured documents, and can help with our code upgrades, maintenance, handover, and more.
For more detailed instructions on phpdocumentor, you can go to its official website
http://manual.phpdoc.org/Check
8. Appendix
Appendix 1:
Keywords that can be identified by Phpdoc:
include
require
include_once
require_once
Define
function
Global
Class
Appendix 2
Tags that can be used in a document
Appendix III:
A piece of PHP code that contains specification comments
/**
* Sample File 2, Phpdocumentor Quickstart
*
* This file demonstrates the rich information so can be
includeD in
* In-code documentation through Docblocks and tags.
* @author Greg Beaver
* @version 1.0
* @package Sample
*/
Sample file #1
/**
* Dummy
includeValue, to demonstrate the parsing power of Phpdocumentor
*/
include_once ' sample3.php ';
/**
* Special global variable Declaration DocBlock
* @global integer $GLOBALS [' _myvar ']
* @name $_myvar
*/
$GLOBALS [' _myvar '] = 6;
/**
* Constants
*/
/**
* First constant
*/
Define (' testing ', 6);
/**
* Second constant
*/
Define (' Anotherconstant ', strlen (' Hello '));
/**
* A Sample Function DocBlock
* @global String Document The fact that this function uses $_myvar
* @staticvar integer $staticvar This is actually what's returned
* @param string $param 1 name to declare
* @param string $param 2 value of the the name
* @return Integer
*/
function Firstfunc ($param 1, $param 2 = ' optional ')
{
static $staticvar = 7;
Global $_myvar;
return $staticvar;
}
/**
* The first example class, this was in the same package as the
* Procedural stuff in the start of the file
* @package Sample
* @subpackage Classes
*/
class MyClass {
/**
* A Sample Private variable, this can is hidden with the--parseprivate
* option
* @access Private
* @var integer|string
*/
var $firstvar = 6;
/**
* @link http://www.example.com Example link
* @see MyClass ()
* @uses testing, Anotherconstant
* @var Array
*/
var $secondvar =
Array
' Stuff ' =
Array
6,
17,
' Armadillo '
),
testing = Anotherconstant
);
/**
* Constructor sets up {@link $firstvar}
*/
function MyClass ()
{
$this->firstvar = 7;
}
/**
* Return a thingie based on $paramie
* @param boolean $paramie
* @return Integer|babyclass
*/
function Parentfunc ($paramie)
{
if ($paramie) {
return 6;
} else {
return new Babyclass;
}
}
}
/**
* @package Sample1
*/
Class Babyclass extends MyClass {
/**
* The answer to life, the Universe and everything
* @var Integer
*/
var $secondvar = 42;
/**
* Configuration Values
* @var Array
*/
var $thirdvar;
/**
* Calls Parent constructor, then increments {@link $firstvar}
*/
function Babyclass ()
{
Parent::myclass ();
$this->firstvar++;
}
/**
* This is always returns a MyClass
* @param ignored $paramie
* @return MyClass
*/
function Parentfunc ($paramie)
{
return new MyClass;
}
}
?>
The above describes the PDP document code annotation specification, including the require,include, global variables, notes, Baidu content, I hope that the PHP tutorial interested in a friend helpful.
-
Start building with 50+ products and up to 12 months usage for Elastic Compute Service
1 on 1 presale consultation
24/7 Technical Support 6 Free Tickets per Quarter Faster Response
Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.
A comprehensive suite of global cloud computing services to power your business
Payment Methods We Support
