search
HomeBackend DevelopmentPHP TutorialSummary of PHP file comment marks and specifications_PHP tutorial

PHP comment tag

@access
Usage scope: class, function, var, define, module
This tag is used to indicate the access rights of keywords: private, public Or protected

@author
Indicate the author

@copyright
Usage scope: class, function, var, define, module, use
Indicate copyright information

@deprecated
Usage scope: class, function, var, define, module, constent, global, include
Indicate unused or obsolete keywords

@example
This tag is used Parse the contents of a file and highlight them. Phpdoc will try to read the file content from the file path given by this tag

@const
Usage scope: define
is used to specify the constant defined in php

@final
Usage scope: class, function, var
Indicates that the keyword is a final class, method, attribute, and prohibits derivation and modification.

@filesource
is similar to example, except that this tag will directly read the content of the currently parsed php file and display it.

@global
Indicates the global variable referenced in this function

@ingore
Used to ignore the specified keyword in the document

@license
Equivalent to in the html tag, first the URL, then the content to be displayed
For example
Baidu> ;
Can be written as @license http://www.baidu.com Baidu

@link
Similar to license
But you can also point to any keyword in the document through link

@name
Specifies an alias for the keyword.

@package
Usage scope: page level -> define, function, include
Class level ->class, var, methods
is used to logically combine one or more keywords are grouped together.

@abstrcut
Indicates that the current class is an abstract class

@param
Specifies the parameters of a function

@return
Specifies a method or function The return pointer is

@static
indicating that the keyword is static.

@var
Indicate the variable type

@version
Indicate the version information

@todo
Indicate what should be improved or not implemented

@throws
Indicates the error exceptions that this function may throw, and the extreme situations

Ordinary document markup tags must be marked with @ at the beginning of each line. In addition, there is This kind of tag is called inline tag, represented by {@}, which includes the following types:

{@link}
Usage is the same as @link

{@source}
Display a paragraph Contents of functions or methods

Annotation specification

a. The annotation must be

/**
* Annotation content
*/

The form is

b. For functions that reference global variables, the glboal tag must be used.

c. For variables, their types must be marked with var (int, string, bool...)

d. Functions must indicate their parameters and return values ​​through param and return tags

e. For keywords that appear twice or more, ignore the redundant ones through ingore and keep only one

f. Where other functions or classes are called, use link or Other tags link to corresponding sections to make the document easier to read.

g. Use non-documentation comments 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

www.bkjia.comtruehttp: //www.bkjia.com/PHPjc/325174.htmlTechArticlePHP comment tag @access Scope of use: class, function, var, define, module This tag is used to specify keywords Access permissions: private, public or protected @author Specifies the author @copyright...
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

MantisBT

MantisBT

Mantis is an easy-to-deploy web-based defect tracking tool designed to aid in product defect tracking. It requires PHP, MySQL and a web server. Check out our demo and hosting services.

Dreamweaver Mac version

Dreamweaver Mac version

Visual web development tools

SublimeText3 Mac version

SublimeText3 Mac version

God-level code editing software (SublimeText3)

PhpStorm Mac version

PhpStorm Mac version

The latest (2018.2.1) professional PHP integrated development tool

WebStorm Mac version

WebStorm Mac version

Useful JavaScript development tools