代码之家  ›  专栏  ›  技术社区  ›  Jakub

PHP注释格式:自动生成还是用户创建?

formatting documentation php
  •  4
  • Jakub  · 技术社区  · 16 年前

    CodeIgniter : 

    /**
 * CodeIgniter
 *
 * An open source application development framework for PHP 4.3.2 or newer
 *
 * @package     CodeIgniter
 * @author      ExpressionEngine Dev Team
 * @copyright   Copyright (c) 2008, EllisLab, Inc.
 * @license     http://codeigniter.com/user_guide/license.html
 * @link        http://codeigniter.com
 * @since       Version 1.0
 * @filesource
 */

    4 回复  |  直到 16 年前
        1
  •  3
  •   Tim Lytle    16 年前

    它是 phpDoc 一些具有反射的框架使用它来动态理解和使用类(由代码本身)。

    IDE还将使用它进行自动补全,显示函数参数等。很高兴知道你的IDE是否为你使用的框架提供了这些功能,而不是你编写的代码。

    PHP's Reflection API

    Zend Framework Extension (including DocBlocks)

    CodeIgniter's Comment Guide (Using DocBlock '...so they can be picked up by IDEs')

    DocBlock Description on phpdoc.org (linked from CI's Style Guide)

        2
  •  1
  •   michaelk    16 年前

    这些评论遵循以下标准 phpdoc here .

    虽然一些IDE支持更容易编写,但实际内容是由程序员手写的。

        3
  •  1
  •   Ashish Joshi    9 年前

    一些IDE可以自动将其放入,但人们通常只需键入即可。

    对于PHP,它是 PHP Documentor quickstart guide here .

    这将扫描您的源代码,并根据您对文件、类和函数的注释创建文档。

        4
  •  -1
  •   zzandy    16 年前

    这是JavaDoc,它可能是由IDE自动生成的。

    推荐文章
    关于   移动版
    代码之家 - 一站式码农服务社区
    沪ICP备11025650号