PHP 类和函数的注释

php syntax standards comments

2022-08-30 17:38:36

我想以一些标准格式为我的（PHP）类及其函数添加一些文档注释，以便其他人更容易理解。

如何为以下类和函数编写注释的示例是什么？

有关类的信息：

类名照片：它具有一些与上传照片和显示照片相关的功能。函数名称为、、。upload()display()delete()

上传功能信息：

上传调整大小并上传图像，并且具有如下所示的几个参数。

<?php
    class Photos extends CI_Controller
    {
        public function upload($file_name, $new_name, $new_width, $new_height, $directory)
        {
            ...
            ...
            returns true or false.
        }

?>

答案 1

PHPDocumentor风格非常标准，大多数IDE和文档生成器都能理解。

  /**
   * Photos
   * 
   * 
   * @package    CI
   * @subpackage Controller
   * @author     YOUR NAME <YOUREMAIL@domain.com>
   */
  class Photos extends CI_Controller
  {

      /**
       * 
       * Uploads a file
       *
       * @param string $file_name  description
       * @param string $new_name  description
       * @param integer $new_width  description
       * @param integer $new_height  description
       * @param string $directory  description
       * @return boolean
       */
      public function upload($file_name, $new_name, $new_width, $new_height, $directory)
      {

      }
   }

答案 2

 /**
 * A sample function docblock
 * @global string document the fact that this function uses $_myvar
 * @staticvar integer $staticvar this is actually what is returned
 * @param string $param1 name to declare
 * @param string $param2 value of the name
 * @return integer
 */
function firstFunc($param1, $param2 = 'optional'){
}

这也将有助于在大多数已知编辑器中自动完成。