PHP: Как се пишат коментари?

[misho]

По-точно въпросът ми е какво се пише в коментарите? Каква е практиката? Например, ако имам един клас, полета, методи... Какво е прието да се пише в коментарите преди един метод, да речем, или дори преди самият клас?

 

[StormBreaker]

По-точно въпросът ми е какво се пише в коментарите? Каква е практиката? Например, ако имам един клас, полета, методи... Какво е прието да се пише в коментарите преди един метод, да речем, или дори преди самият клас?

За какво се използва, какъв тип параметри приема и какво връща. Гугълни за phpdoc

 

[alex3]

Ето ти един пример.

class etc
{
    public static function testthat($param1, $param2)
    {
         return ($param1 % $param2 == 0)  ? true : false;
    }
}

/**
* Описанието на функцията (какво прави)
*
* @param string $param1
* @param string $param2
*
* @return boolean
*
*/

В първата част на @param слагаш вида на параметъра (array, string, int, bool..) и в другата част функцията.

Накрая какво връща функцията.

class etc
{
    /**
      * Описанието на функцията (какво прави)
      *
      * @param string $param1
      * @param string $param2
      *
      * @return boolean
      *
      */
    public static function testthat($param1, $param2)
    {
         return ($param1 % $param2 == 0)  ? true : false;
    }
}