PHP Document code annotation Specification

1. What is phpbench entor?
PHPDocumentor is a tool written in PHP. For php programs with standardized annotations, it can quickly generate API documents with functions such as mutual reference and indexing. The old version is phpdoc. It was renamed phpDocumentor from 1.3.0. The new version is added with support for the php5 syntax. At the same time, you can generate documents through operations on the client browser, the document can be converted to PDF, HTML, or CHM format, which is very convenient.
When PHPDocumentor is working, it will scan the php source code under the specified directory, scan the keywords, extract the comments to be analyzed, and then analyze the specific tags in the comments to generate xml files, then, an index is created based on the analyzed class and module information to generate an xml file. For the generated xml file, a custom template is used to output the file in the specified format.
2. Install phpDocumentor
Like other pear modules, phpbench entor can be installed automatically or manually. Both methods are very convenient:
A. Automatic Installation through pear
Enter
Pear install PhpDocumentor
B. Manual Installation
Download the latest phpbench entor (1.4.0) at http://manual.phpdoc.org/and decompress the content.
3. How to generate a document using phpbench entor
Command Line Method:
Enter
Php-h
A detailed parameter table is displayed. Several important parameters are as follows:
-F name of the file to be analyzed. Multiple files are separated by commas.
-D directory to be analyzed. multiple directories are separated by commas.
-T: storage path of the generated document
-O output file format. The structure is output format: converter name: Template directory.
Example: phpdoc-o HTML: frames: earthli-f test. php-t docs
Web Interface Generation
In the new phpdoc, in addition to generating documents under the command line, you can also generate documents on the client browser, the specific method is to put the content of PhpDocumentor under the apache directory so that it can be accessed through a browser. The following interface is displayed after access:
Click the files button and select the PHP file or folder to be processed. You can also specify Files to ignore on this interface to ignore the processing of some files.
Click the output button to select the path and format of the generated document.
Finally, click create. The phpdocumentor automatically starts generating the document. The progress and status of the generated document are displayed at the bottom.
Total Documentation Time: 1 seconds
Done
Operation Completed !!
Then, we can use the generated document. If it is in the simplified format, it is named documentation.pdf.
4. Add standard comments to the php code
PHPDocument is to generate a document from the comments of your source code. Therefore, the process of commenting your program is the process of compiling the document.
From this point on, PHPdoc prompts you to develop good programming habits, try to use specifications, clear text for your program to make comments, at the same time, it also avoids the problem of non-sync preparation of documents and updates later.
In phpdocumentor, annotations are classified into document comments and non-document comments.
Document comments are multi-line comments placed before specific keywords. specific keywords refer to keywords that can be analyzed by phpdoc, such as class and var. For details, refer to Appendix 1.
Comments that are not preceded by keywords or are not standardized are called non-document comments. These comments will not be analyzed by phpdoc or appear in your generated api text.
3.2 How to Write document comments:
All document comments are a multi-line comments starting with/**. In phpDocumentor, DocBlock refers to the help information written by software developers about a keyword, this allows others to know the specific purpose of this keyword and how to use it. PhpDocumentor specifies that a DocBlock contains the following information:
1. Function overview Area
2. Detailed description area
3. tag
The first line of document comments is the function description area. The body is generally a concise description of the functions of this class, method, or function, the body of the function description is displayed in the index area in the generated document. The content in the function description area can end with a blank line or.
There is a blank line behind the function description area, followed by a detailed description area. This section mainly describes the functions and usage of your API. If possible, it can also be used as an example. In this section, you should focus on the common usage and usage of your API functions or methods, and specify whether it is cross-platform (if involved). For platform-related information, you need to treat it differently from general information. The common practice is to set up another line, and then write the precautions or special information on a specific platform. This information should be sufficient, this allows your readers to write test information, such as boundary conditions, parameter ranges, and breakpoints.
It is also a blank line, followed by the tag of the document, indicating some technical information, mainly the call parameter type, the return value is extremely type, inheritance relationship, related methods/functions.
For more information about document tagging, see Section 4: Document tagging.
For more information, see appendix 2.
Below is an example of document comment
/**
* Add the function to add two numbers.
*
* In a simple addition calculation, the function accepts two numbers a and B and Returns their and c
*
* @ Param int Addition
* @ Param int add count
* @ Return integer
*/
Function Add ($ a, $ B ){
Return $ a + $ B;
}
The generated document is as follows:
Add
Integer Add (int $ a, int $ B)
[Line 45]
Function add to add two numbers
Constants is a simple addition calculation. The function accepts two numbers a and B and Returns their and c
Parameters
• Int $ a-addend
• Int $ B-Number of added parts
5. Document Tag:
The scope of use of a document tag is a keyword that can be used to modify a document tag, or other document tag.
All document tags start with @ after each line. If @ is marked in the middle of a passage, the mark will be ignored as common content.
@ Access
Usage scope: class, function, var, define, module
Indicates the access permission for a keyword: private, public, or proteced.
@ Author
Specify author
@ Copyright
Usage scope: class, function, var, define, module, use
Copyright information
@ Deprecated
Usage scope: class, function, var, define, module, constent, global, include
Specify unnecessary or obsolete keywords
@ Example
This tag is used to parse the content of a file and highlight it. Phpdoc will try to read the file content from the file path marked
@ Const
Scope of use: define
Used to specify the define constant in php
@ Final
Usage scope: class, function, var
Specifies that a keyword is a final class, method, or attribute, and cannot be derived or modified.
@ Filesource
Similar to example, however, this tag will directly read and display the content of the currently resolved PHP file.
@ Global
Specifies the global variables referenced in this function.
@ Ingore
Used to ignore specified keywords in the document
@ License
It is equivalent to <a> in an html Tag, first the URL, and then the content to be displayed.
For example, <a href = "http://www.baidu.com"> Baidu </a>
Can write @ license http://www.baidu.com Baidu
@ Link
Similar to license
However, you can refer to any keyword in the document through link.
@ Name
Specify an alias for the keyword.
@ Package
Scope of use: page-> define, function, include
Class-> class, var, methods
It is used to logically group one or more keywords into one group.
@ Shortcut
Indicates that the current class is an abstract class.
@ Param
Specify the parameters of a function.
@ Return
Specifies the return value of a method or function.
@ Static
Indicates that the word is static.
@ Var
Variable type
@ Version
Specify version information
@ Todo
Specify the areas to be improved or not implemented
@ Throws
Indicates the error exception that this function may throw.
As mentioned above, the mark of common documents must start with @ at the beginning of each line. In addition, there is also a Mark called inline tag, which is represented by {@}, including the following:
{@ Link}
Usage: @ link
{@ Source}
Display the content of a function or Method
6. Some annotation specifications
A. The comment must be
/**
* XXXXXXX
*/
Format
B. The glboal mark must be used for functions that reference global variables.
C. For variables, you must use var to mark their types (int, string, bool ...)
D. The function must specify its parameters and return values through param and return tags.
E. For keywords that appear twice or more times, ignore unnecessary keywords through ingore and retain only one keyword.
F. When other functions or classes are called, link or other markup should be used to link to the corresponding part for easy reading of the document.
G. Use non-document comments as necessary to improve ease of coding.
H. The descriptive content should be as concise as possible and use phrases instead of sentences as much as possible.
I. global variables, static variables and constants must be marked with corresponding descriptions
7. Summary
PhpDocumentor is a very powerful Automatic Document generation tool. It helps us write standard comments, generate easy-to-understand and well-structured documents, and upgrade and maintain our code, the handover and so on are of great help.
For more details about phpDocumentor, visit its official website.
Http://manual.phpdoc.org/check
8. Appendix
Appendix 1:
Keywords that can be recognized by phpdoc:
Include
Require
Include_once
Require_once
Define
Function
Global
Class
Appendix 2
Tags that can be used in the document
<B>
<Code>
<Br>
<Kdb>
<Li>
<Pre>
<Ul>
<Samp>
<Var>
Appendix 3:
A piece of php code containing standard comments:
Copy codeThe Code is as follows:
<? Php
/**
* Sample File 2, phpbench entor Quickstart
*
* This file demonstrates the rich information that can be stored in
* In-code documentation through DocBlocks and tags.
* @ Author Greg Beaver <[email] cellog@php.net [/email]>
* @ Version 1.0
* @ Package sample
*/
// Sample file #1
/**
* Dummy include value, to demonstrate the parsing power of php#entor
*/
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 is returned
* @ Param string $ param1 name to declare
* @ Param string $ param2 value of the name
* @ Return integer
*/
Function firstFunc ($ param1, $ param2 = 'optional '){
Static $ staticvar = 7;
Global $ _ myvar;
Return $ staticvar;
}
/**
* The first example class, this is in the same package as
* Procedural stuff in the start of the file
* @ Package sample
* @ Subpackage classes
*/
Class myclass {
/**
* A sample private variable, this can be hidden with the -- parseprivate
* Option
* @ Accessprivate
* @ 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;
/**
* Callparent constructor, then increments {@ link $ firstvar}
*/
Function babyclass (){
Parent: myclass ();
$ This-> firstvar ++;
}
/**
* This always returns a myclass
* @ Param ignored $ paramie
* @ Return myclass
*/
Function parentfunc ($ paramie ){
Return new myclass;
}
}
?>