Вот смотрите, если я используя тот или иной редактор кода, ввожу встроенную функцию мне сразу выводит описание данной функции ( http://s52.radikal.ru/i137/1405/58/26c169fda65c.jpg ), а можно как нибудь комментировать собственные функции что бы к ним отображалось подобное описание?
Да. Есть такая штука, называется PHPDoc. Выглядит примерно вот так: Код (PHP): /** * Registration form * @return \Illuminate\View\View */ public function getRegistration() { return \View::make('auth.registration'); } Нормальная IDE должна это цеплять и выдавать подсказки. http://www.phpdoc.org/docs/latest/index.html
Спасибо. А можете написать как правильно за комментировать обыкновенную переменную, а то у меня в IDE (NetBeans IDE 7.4) пишет что не найден документ, пишу так: Код (Text): /** * @var string $str строковая переменная */ $str = "строка"; или так: Код (Text): /** * строковая переменная * @var string $str */ $str = "строка"; и еще 500 разных вариантов, но ни чего не помогает.
Позволю себе спросить: а для чего? функции документировать - понятно, а переменную зачем? Имя оной и есть ее документация.
Я просто поискал по интернету про PHPDoc нашел пару сайтов, на одном из них документировалась переменная, вот я и решил, что так должно быть.
Там была просто переменная, ну вообщем то не важно, я уже понял что переменную комментировать не надо
"Всё хорошо, что в меру" (с) igordata прав, - надо, когда надо. А вот с PHPDoc @var не всё одназначно Выше я утверждал, что всё работает, но я был не прав. Работает только для свойств объекта. Для переменной можно указать только тип (/** @var string $myVar */ ), описание не подхватывается/показывается. п.с. Кстати, даже на официальном сайте в @var нет описания (глюк, конечно, но...).
Угу, каюсь. Не подумал, что может быть разное поведение, вот и ляпнул, не проверивши. А потом проверил.