search
HomeBackend DevelopmentPHP TutorialSummary of PHPDocument code comment specifications_PHP Tutorial

Summary of PHPDocument code comment specifications_PHP Tutorial

Jul 21, 2016 pm 03:03 PM
phpdocumentorNocodeaboutCommand LineexistInstallSummarizerecommendCommentofspecification

1. Install phpDocumentor (command line installation is not recommended)
Download the latest version of PhpDoc at http://manual.phpdoc.org/
Put it in the web server directory to make it pass The browser can access
click the files button and select the php files or folders to be processed
You can also ignore the processing of certain files by specifying Files to ignore in this interface.
Then click the output button to select the storage path and format of the generated document.
Finally click create, and phpdocumentor will automatically start generating the document.

2. How to write PHP specification comments
All documentation tags start with @ after * on each line. If the @ mark appears in the middle of a paragraph, the mark will be treated as normal content and ignored.
@access This tag is used to indicate the access permission of keywords: private, public or protected. Scope of use: class, function, var, define, module
@author specifies the author
@copyright specifies copyright information
@const Scope of use: define Used to specify the constant defined in PHP
@final Scope of use: class, function, var Specifies that the keyword is a final class, method, attribute, and prohibits derivation and modification.
@global specifies the global variable referenced in this function
@name specifies an alias for the keyword.
@package is used to logically group 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 the return value of a method or function
@static indicates that the keyword is static.
@var specifies the variable type
@version specifies the version information
@todo specifies areas that should be improved or not implemented
@link You can point to any keyword in the document through link
@ ingore is used to ignore specified keywords in the document

Some comment specifications
a. Comments must be in the form of
/**
* XXXXXXX
*/

b. For functions that reference global variables, they must Use glboal tag.
c. For variables, their types (int, string, bool...) must be marked with var
d. Functions must indicate their parameters and return values ​​through param and return markers
e. For two occurrences For keywords used twice or more, the redundant ones should be ignored through ingore, and only one should be kept
f. Where other functions or classes are called, link or other tags should be used to link to the corresponding part to facilitate documentation. of reading.
g. Use non-documentation comments (comments before keywords that PHPDOC cannot recognize) where necessary to improve code readability.
h. Keep descriptive content concise and to the point, using phrases rather than sentences whenever possible.
i. Global variables, static variables and constants must be declared with corresponding tags

Keywords that can be recognized by phpdoc:
Include
Require
include_once
require_once
define
function
global
class

3. Standard annotated php code:
/**
* File name (sample2.php)
*
* Function description (omitted)
*
* @author steve
* @version 1.0
* @package sample2
*/
/**
* Include files
*/
include_once 'sample3.php';
/**
* Declare global variables
* @global integer $GLOBALS['_myvar']
* @name $_myvar
*/
$GLOBALS['_myvar'] = 6;
/**
* Declare global constants
*/
define('NUM', 6);
/**
* Class name
*
* Class function description
*
* @package sample2
* @subpackage classes (add if it is a parent class)
*/
class myclass {
/**
* Declare ordinary variables
*
* @accessprivate
* @var integer|string
*/
var $firstvar = 6;
/**
* Create constructor {@link $firstvar}
* /
function myclass() {
$this->firstvar = 7;
}
/**
* Define function
*
* Function description
*
* @global string $_myvar
* @staticvar integer $staticvar
* @param string $param1
* @param string $param2
* @return integer|string
*/
function firstFunc($param1, $param2 = 'optional ') {
static $staticvar = 7;
global $_myvar;
return $staticvar;
}
}
?>

www.bkjia.comtruehttp: //www.bkjia.com/PHPjc/327853.htmlTechArticle1. Install phpDocumentor (command line installation is not recommended) Download the latest from http://manual.phpdoc.org/ The version of PhpDoc is placed in the web server directory so that it can be accessed through the browser by clicking f...
Statement
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn
The Continued Use of PHP: Reasons for Its EnduranceThe Continued Use of PHP: Reasons for Its EnduranceApr 19, 2025 am 12:23 AM

What’s still popular is the ease of use, flexibility and a strong ecosystem. 1) Ease of use and simple syntax make it the first choice for beginners. 2) Closely integrated with web development, excellent interaction with HTTP requests and database. 3) The huge ecosystem provides a wealth of tools and libraries. 4) Active community and open source nature adapts them to new needs and technology trends.

PHP and Python: Exploring Their Similarities and DifferencesPHP and Python: Exploring Their Similarities and DifferencesApr 19, 2025 am 12:21 AM

PHP and Python are both high-level programming languages ​​that are widely used in web development, data processing and automation tasks. 1.PHP is often used to build dynamic websites and content management systems, while Python is often used to build web frameworks and data science. 2.PHP uses echo to output content, Python uses print. 3. Both support object-oriented programming, but the syntax and keywords are different. 4. PHP supports weak type conversion, while Python is more stringent. 5. PHP performance optimization includes using OPcache and asynchronous programming, while Python uses cProfile and asynchronous programming.

PHP and Python: Different Paradigms ExplainedPHP and Python: Different Paradigms ExplainedApr 18, 2025 am 12:26 AM

PHP is mainly procedural programming, but also supports object-oriented programming (OOP); Python supports a variety of paradigms, including OOP, functional and procedural programming. PHP is suitable for web development, and Python is suitable for a variety of applications such as data analysis and machine learning.

PHP and Python: A Deep Dive into Their HistoryPHP and Python: A Deep Dive into Their HistoryApr 18, 2025 am 12:25 AM

PHP originated in 1994 and was developed by RasmusLerdorf. It was originally used to track website visitors and gradually evolved into a server-side scripting language and was widely used in web development. Python was developed by Guidovan Rossum in the late 1980s and was first released in 1991. It emphasizes code readability and simplicity, and is suitable for scientific computing, data analysis and other fields.

Choosing Between PHP and Python: A GuideChoosing Between PHP and Python: A GuideApr 18, 2025 am 12:24 AM

PHP is suitable for web development and rapid prototyping, and Python is suitable for data science and machine learning. 1.PHP is used for dynamic web development, with simple syntax and suitable for rapid development. 2. Python has concise syntax, is suitable for multiple fields, and has a strong library ecosystem.

PHP and Frameworks: Modernizing the LanguagePHP and Frameworks: Modernizing the LanguageApr 18, 2025 am 12:14 AM

PHP remains important in the modernization process because it supports a large number of websites and applications and adapts to development needs through frameworks. 1.PHP7 improves performance and introduces new features. 2. Modern frameworks such as Laravel, Symfony and CodeIgniter simplify development and improve code quality. 3. Performance optimization and best practices further improve application efficiency.

PHP's Impact: Web Development and BeyondPHP's Impact: Web Development and BeyondApr 18, 2025 am 12:10 AM

PHPhassignificantlyimpactedwebdevelopmentandextendsbeyondit.1)ItpowersmajorplatformslikeWordPressandexcelsindatabaseinteractions.2)PHP'sadaptabilityallowsittoscaleforlargeapplicationsusingframeworkslikeLaravel.3)Beyondweb,PHPisusedincommand-linescrip

How does PHP type hinting work, including scalar types, return types, union types, and nullable types?How does PHP type hinting work, including scalar types, return types, union types, and nullable types?Apr 17, 2025 am 12:25 AM

PHP type prompts to improve code quality and readability. 1) Scalar type tips: Since PHP7.0, basic data types are allowed to be specified in function parameters, such as int, float, etc. 2) Return type prompt: Ensure the consistency of the function return value type. 3) Union type prompt: Since PHP8.0, multiple types are allowed to be specified in function parameters or return values. 4) Nullable type prompt: Allows to include null values ​​and handle functions that may return null values.

See all articles

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

Video Face Swap

Video Face Swap

Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Tools

SublimeText3 English version

SublimeText3 English version

Recommended: Win version, supports code prompts!

mPDF

mPDF

mPDF is a PHP library that can generate PDF files from UTF-8 encoded HTML. The original author, Ian Back, wrote mPDF to output PDF files "on the fly" from his website and handle different languages. It is slower than original scripts like HTML2FPDF and produces larger files when using Unicode fonts, but supports CSS styles etc. and has a lot of enhancements. Supports almost all languages, including RTL (Arabic and Hebrew) and CJK (Chinese, Japanese and Korean). Supports nested block-level elements (such as P, DIV),

SublimeText3 Mac version

SublimeText3 Mac version

God-level code editing software (SublimeText3)

MinGW - Minimalist GNU for Windows

MinGW - Minimalist GNU for Windows

This project is in the process of being migrated to osdn.net/projects/mingw, you can continue to follow us there. MinGW: A native Windows port of the GNU Compiler Collection (GCC), freely distributable import libraries and header files for building native Windows applications; includes extensions to the MSVC runtime to support C99 functionality. All MinGW software can run on 64-bit Windows platforms.

Atom editor mac version download

Atom editor mac version download

The most popular open source editor