PHP类和函数的注释？

Question

我想以一些标准格式为我的(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.
    }

Answer 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)
      {

      }
   }