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

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

  •  4
  • Jakub  · 技术社区  · 15 年前

    我经常在PHP中看到这些头注释,并且经常想知道是否使用了一些软件来设置它们?我好像还记得JavaDoc什么的?但我不确定这是否是自动生成的?或者这只是某种类型的文档标准?

    下面的示例来自 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 回复  |  直到 8 年前
        1
  •  3
  •   Tim Lytle    15 年前

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

    IDES还将把它用于自动完成、显示函数参数等。很好地知道您的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    15 年前

    这些评论遵循 phpdoc 可以用来自动生成代码的文档。您可以看到这样一个文档的示例 here .

    虽然有些IDE支持更轻松地编写它们,但实际内容是由程序员手工编写的。

        3
  •  1
  •   Ashish Joshi    8 年前

    有些IDE可以自动输入,但人们通常只是输入。

    对于PHP来说 PHP Documentor 你可以看到一个 quickstart guide here .

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

        4
  •  -1
  •   zzandy    15 年前

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