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