Комментарии в стиле phpdoc - формат комментариев - как правильно комментировать пример

Комментарии в стиле phpdoc

Перед методом класса можно писать так:

/**
   * Функция получает путь к файлу для печати на стрице-
  * вызывается без параметров 
   * 
   * @param string $str - строка, необходима для того-то... 
   * @return string
   */
    public function getWebPath($str) {

То есть:

  1. начинаем комментарий с /**
  2. каждая строка начинается со звёздочки *
  3. @param - начало строки для описания типа и назначения переменной (входящей)
  4. @return - описание возвращаемого значения (тоже указываем тип)

Вот какой вот формат =) Позволяет потом автоматически собрать очень удобную документацию.