PHP编程之道
简体中文(ZH-CN) English(EN) 繁体中文(ZH-TW) 日本語(JA) 한국어(KO) Melayu(MS) Français(FR) Deutsch(DE)
annuaire recherche
前言 入门指南 代码风格指南 语言亮点 编程范式 命名空间 PHP标准库 命令行接口 Xdebug 依赖管理 使用当前稳定版本的 PHP (7.1) Mac 系统安裝 PHP Windows 系统安裝 PHP 内置的 web 服务器 Composer 与 Packagist PEAR 介绍 开发实践 基础知识 日期和时间 设计模式 使用 UTF-8 编码 国际化 (i18n) 与本地化 (l10n) 一般的实现方法 Gettext 依赖注入 基本概念 复杂的问题 容器 数据库 MySQL 扩展 PDO 扩展 数据库交互 数据库抽象层 使用模板 好处 原生 PHP 模板 编译型模板 错误与异常 错误 异常 安全 Web 应用程序安全 密码哈希 数据过滤 配置文件 注册全局变量 错误报告 测试 测试驱动开发 其他测试工具 服务器与部署 虚拟或专用服务器 共享主机 构建及部署应用 虚拟化技术 Vagrant 简介 Docker 简介 缓存 Opcode 缓存 对象缓存 文档撰写 PHPDoc 资源 PHP 官方 值得关注的大牛 指导 PHP 的 Paas 提供商 框架 组件 其他有用的资源 书籍 社区 PHP 用户组 PHP 会议 ElePHPants

©
Ce document utilise Manuel du site Web PHP chinois Libérer

personnages

PHPDoc 是注释 PHP 代码的非正式标准。它有许多不同的标记可以使用。完整的标记列表和范例可以查看 PHPDoc 指南。

如下是撰写类方法时的一种写法：

<?php 
/**  
* @author A Name <a.name@example.com>  
* @link http://www.phpdoc.org/docs/latest/index.html  
*/ 
class DateTimeHelper {     
    /**      
    * @param mixed $anything Anything that we can convert to a \DateTime object      
    *      
    * @throws \InvalidArgumentException      
    *      
    * @return \DateTime      
    */     
    public function dateTimeFromAnything($anything){         
        $type = gettype($anything);         
        switch ($type) {            
         // Some code that tries to return a \DateTime object         
         }         
         throw new \InvalidArgumentException(             
             "Failed Converting param of type '{$type}' to DateTime object"         );     
             }     
             /**      
             * @param mixed $date Anything that we can convert to a \DateTime object      
             *      
             * @return void      
             */     
             public function printISO8601Date($date){         
                 echo $this->dateTimeFromAnything($date)->format('c');     
                 }     
                 /**      
                 * @param mixed $date Anything that we can convert to a \DateTime object      
                 */     
                 public function printRFC2822Date($date){         
                     echo $this->dateTimeFromAnything($date)->format('r');     
                 } 
}

这个类使用了 @author 和 @link 标记来为整个类添加说明。 @author 标记是用來说明代码的作者，在多位开发者的情况下，可以同时列出好几位作者。其次 @link 标记用来提供网站链接，进一步说明代码和网站之间的关系。

在这个类中，第一个方法的 @param 标记，说明类型、名字和传入方法的参数。此外，@return 和 @throws 标记分别说明返回类型以及可能抛出的异常。

第二和第三个方法非常类似，和第一个方法一样使用了一个 @param 标记。第二、和第三个方法之间关键差別在注释区块使用／排除 @return 标记。@return void 标记明确告诉我们没有返回值，而过去省略 @return void 声明也具有相同效果（沒有返回任何值）。

Article précédent： Article suivant：