documentation

У меня есть метод, который возвращает текущий объект, как мне это задокументировать? /** * set something * * @retur ... Something(){ // ... return $this; } Или я должен сделать @return self или @return Current_Class_Name?

Я знаю, что существует много различных стандартов для встроенной документации по PHP-коду. Вот что я подразумеваю под в ... тересует создание руководств - я хочу знать, как сгенерировать тип кода, описанный выше, или "встроенный документация".

У меня есть несколько законченных, старых PHP-проектов с большим количеством включений, которые я хотел бы документиров ... едставить, что инструмент C/Java может обрабатывать файлы PHP после некоторой настройки. Спасибо за ваш большой вклад!

Из того, что я исследовал, я, похоже, не могу найти правильный метод форматирования многострочной строки phpdoc @param. ... string; } Было бы это правильно, или вы бы не добавляли отступы, или просто сохранили бы все в одной длинной строке?

Использует ли кто-нибудь что-нибудь еще для документирования своего кода PHP, кроме PHPDoc? Существуют ли какие-либо инструменты, которые читают тот же синтаксис документации, но дают более богатый вывод?

Как мне документировать константы классов для PHPDoc? Я прочитал руководство, но ничего не могу найти о них.

Я часто путешествую и часто нахожусь без подключения к Интернету, поэтому я искал автономную документацию PHP для Mac O ... , что и в официальной автономной документации PHP. Как я могу получить полную документацию по PHP в автономном режиме?

Я хотел бы создать несколько небольших, но качественно настроенных сайтов документации для нескольких проектов. phpDocu ... кты только для синтаксического анализа DocBlock, которые помогут мне в этой задаче, или я застрял, изобретая это колесо?

Хорошо, у меня есть этот phpdoc выше моего метода класса /** * this a function that translates the text * @param str ... вующая документация приложения, над которым я сейчас работаю. Ну, я назначен для того, чтобы все хорошо документировать.

Я всегда был за документирование кода, но когда дело доходит до AJAX + PHP, это не всегда легко: код действительно разб ... ления? Примечание: Этот вопрос относится к любым приложениям на стороне клиента+сервера, а не только к Javascript+PHP.

Я разрабатываю с Eclipse + PDT. Я добавлял комментарии phpdoc в свой код, но на самом деле никогда не создавал результи ... e. Как мне это сделать - есть ли какая-то функциональность в Eclipse, или генерация документов должна выполняться извне?

Вопрос довольно прост - как я должен различать phpdoc для интерфейса и для интерфейса, реализующего класс? Должны/могут ... ли должна выглядеть документация? Более общий для интерфейса и более конкретно для класса, реализующего этот интерфейс?

API отражения - отличная вещь для управления материалами ООП, и похоже, что большинство разработчиков даже не знают об ... щим, другими словами, могу ли я использовать его в своей платформе MVC? Почему он используется реже, что-то не так с ним?

Допустим, у меня есть такая функция: function theFunction() { $arr = array(); for ($i=0;$i<10;$i++) { ... ть, и мало что говорит разработчику об истинной природе функции. Как мне документировать тип "массив [типа]" в PHPDoc?

У нас есть "веб-приложение", которое было разработано за последние 7 месяцев. Проблема в том, что на самом деле это не ... оставшихся 24 часов этой задаче документирования. Так что, да, все мрачно, но 24 часа - это совсем немного... верно? :-\

У меня есть простой вопрос, который я не смог найти в Google. Я перемещаю документацию по своему проекту из PHPDoc в ... орым я разрабатываю, может быть использован: одна из многих комбинаций CreativeCommons, GNU, MIT, BSD "под лицензия"...

Раньше я никогда особо не заботился о документировании своего кода, но недавно я начал работать над проектом с открытым ... рт? Насколько это надежно? Есть ли какое-то будущее, или мы имеем дело с зомби, и вся надежда потеряна... Спасибо, Иво

Я просматривал документацию для PHPDoc и не смог найти хорошего способа документировать переменные Post, которые я отпр ... должен просто вручную документировать все и игнорировать поиск автоматического инструмента документирования? Спасибо!

Какой из следующих способов является правильным для документирования типа возвращаемого значения этого метода для phpDo ... я IDE от любого из методов? Редактировать: Похоже, что как PhpStorm, так и IDE Netbeans 7.1+ поддерживают 2-й метод.

Еще один сотрудник и я сильно модифицировали расширение PHP Zookeeper, но единственное, что меня действительно беспокои ... артные расширения PHP создают для вас исключение. Существует ли альтернативный источник документации по API PHP/Zend c?