Home php教程 php手册 php的注释规范

php的注释规范

Jun 13, 2016 am 11:34 AM
class define function module php var Comment of specification

  @access

  使用范围:class,function,var,define,module

  该标记用于指明关键字的存取权限:private、public或proteced

  @author

  指明作者

  @copyright

  使用范围:class,function,var,define,module,use

  指明版权信息

  @deprecated

  使用范围:class,function,var,define,module,constent,global,include

  指明不用或者废弃的关键字

  @example

  该标记用于解析一段文件内容,并将他们高亮显示。Phpdoc会试图从该标记给的文件路径中读取文件内容

  @const

  使用范围:define

  用来指明php中define的常量

  @final

  使用范围:class,function,var

  指明关键字是一个最终的类、方法、属性,禁止派生、修改。

  @filesource

  和example类似,只不过该标记将直接读取当前解析的php文件的内容并显示。

  @global

  指明在此函数中引用的全局变量

  @ingore

  用于在文档中忽略指定的关键字

  @license

  相当于html标签中的,首先是URL,接着是要显示的内容

  例如百度

  可以写作 @license http://www.baidu.com 百度

  @link

  类似于license

  但还可以通过link指到文档中的任何一个关键字

  @name

  为关键字指定一个别名。

  @package

  使用范围:页面级别的-> define,function,include

  类级别的->class,var,methods

  用于逻辑上将一个或几个关键字分到一组。

  @abstrcut

  说明当前类是一个抽象类

  @param

  指明一个函数的参数

  @return

  指明一个方法或函数的返回指

  @static

  指明关建字是静态的。

  @var

  指明变量类型

  @version

  指明版本信息

  @todo

  指明应该改进或没有实现的地方

  @throws

  指明此函数可能抛出的错误异常,极其发生的情况

  上面提到过,普通的文档标记标记必须在每行的开头以@标记,除此之外,还有一种标记叫做inline tag,用{@}表示,具体包括以下几种:

  {@link}

  用法同@link

  {@source}

  显示一段函数或方法的内容

Statement of this Website
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

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

AI Hentai Generator

AI Hentai Generator

Generate AI Hentai for free.

Hot Article

R.E.P.O. Energy Crystals Explained and What They Do (Yellow Crystal)
3 weeks ago By 尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. Best Graphic Settings
2 weeks ago By 尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. How to Fix Audio if You Can't Hear Anyone
3 weeks ago By 尊渡假赌尊渡假赌尊渡假赌

Hot Tools

Notepad++7.3.1

Notepad++7.3.1

Easy-to-use and free code editor

SublimeText3 Chinese version

SublimeText3 Chinese version

Chinese version, very easy to use

Zend Studio 13.0.1

Zend Studio 13.0.1

Powerful PHP integrated development environment

Dreamweaver CS6

Dreamweaver CS6

Visual web development tools

SublimeText3 Mac version

SublimeText3 Mac version

God-level code editing software (SublimeText3)

CakePHP Project Configuration CakePHP Project Configuration Sep 10, 2024 pm 05:25 PM

In this chapter, we will understand the Environment Variables, General Configuration, Database Configuration and Email Configuration in CakePHP.

PHP 8.4 Installation and Upgrade guide for Ubuntu and Debian PHP 8.4 Installation and Upgrade guide for Ubuntu and Debian Dec 24, 2024 pm 04:42 PM

PHP 8.4 brings several new features, security improvements, and performance improvements with healthy amounts of feature deprecations and removals. This guide explains how to install PHP 8.4 or upgrade to PHP 8.4 on Ubuntu, Debian, or their derivati

CakePHP Date and Time CakePHP Date and Time Sep 10, 2024 pm 05:27 PM

To work with date and time in cakephp4, we are going to make use of the available FrozenTime class.

CakePHP Routing CakePHP Routing Sep 10, 2024 pm 05:25 PM

In this chapter, we are going to learn the following topics related to routing ?

CakePHP File upload CakePHP File upload Sep 10, 2024 pm 05:27 PM

To work on file upload we are going to use the form helper. Here, is an example for file upload.

CakePHP Working with Database CakePHP Working with Database Sep 10, 2024 pm 05:25 PM

Working with database in CakePHP is very easy. We will understand the CRUD (Create, Read, Update, Delete) operations in this chapter.

Discuss CakePHP Discuss CakePHP Sep 10, 2024 pm 05:28 PM

CakePHP is an open-source framework for PHP. It is intended to make developing, deploying and maintaining applications much easier. CakePHP is based on a MVC-like architecture that is both powerful and easy to grasp. Models, Views, and Controllers gu

CakePHP Creating Validators CakePHP Creating Validators Sep 10, 2024 pm 05:26 PM

Validator can be created by adding the following two lines in the controller.

See all articles