web-dev-qa-db-ja.com

PHPクラスと関数？

他の人が理解しやすいように、私の（PHP）クラスとその関数のドキュメントコメントを標準形式で追加したいと思います。

次のクラスと関数に対するコメントをどのように書くか、例を挙げていただければ私は明記しますか？ありがとう。

クラスに関する情報：

Classname Photos：写真のアップロードと表示に関連するいくつかの機能があります。関数名は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.
    }
phpsyntaxcommentsstandards
21
sunjie

PHPDocumentor スタイルはかなり標準的であり、ほとんどのIDEおよびドキュメントジェネレーターで理解されています。

  /**
   * Photos
   * 
   * 
   * @package    CI
   * @subpackage Controller
   * @author     YOUR NAME <[email protected]>
   */
  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)
      {

      }
   }
42
prodigitalson
 /**
 * 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'){
}

これは、ほとんどの既知のエディターでのオートコンプリートにも役立ちます

2
fatnjazzy

あなたは doxygen を見たいかもしれません。それらの構文に従うと、ドキュメントを自動生成できるだけでなく（実際にはそれほど便利ではありません）、Zend IDEは、自動補完に関するコードヒントを提供します（つまり、ドキュメントを表示します）関数名の入力を開始したとき）。

/*! \brief My Photo Class
 *  Does some stuff with photos
 */
class Photos extends CI_Controller
{
  /*! \brief Uploads a file
   *  \param $file_name The name of the file
   *  ...
   *  \returns A value indicating success
   */
  public function upload($file_name, $new_name, $new_width, new_$height, $directory)
  {
    ...
    ...
    returns true or false.
  }
}
0
briantyler