PHP类和函数的评论？

我想为我的( PHP)类及其功能添加一些标准格式的文档注释,以便其他人更容易理解.

如果你能给我一个例子,你会如何写下面的类和功能的注释,我会喜欢吗？谢谢.

关于课程的信息

Classname照片：它具有与上传照片和显示照片相关的一些功能.函数名称为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.
    }

/**
   * 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_$height,$directory)
      {

      }
   }

（编辑：安卓应用网）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!