Модераторы: skyboy, MoLeX, Aliance, ksnk
  

Поиск:

Ответ в темуСоздание новой темы Создание опроса
> Документирование get/post данных (phpdoc), которые передаются в ф-ию контроллера 
:(
    Опции темы
Ripper
Дата 8.10.2012, 12:59 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Lonely soul...
**


Профиль
Группа: Участник
Сообщений: 920
Регистрация: 30.6.2004
Где: г. Москва

Репутация: 1
Всего: 23



Добрый день
Использую CodeIgniter. В нем у меня несколько контроллеров, в них - несколько ф-ий. Этим ф-иям передаются get/post параметры. Т.е. получается что-то вроде API с набором ф-ий. Как их задокументировать?

Если например, в моделях ф-ии принимают параметры "естественным" образом ( function test($a, $b) ) и с помощью phpdoc все нормально документируется (@param int ...), то когда я пытаюсь сделать то же самое для ф-ий контроллера, он ругается что не находит такие параметры (ибо их нет). Но как тогда документировать get/post параметры?

Т.е. я пытался сделать что то вроде:
Код

/**
* get user info
* @param int $id user id
*/
function getUser() {
$id = $this->input->get('id');
....
}

Но не проходит. Либо просто описывать внутри описания ф-ии? Например с помощью списка ul перечислять параметры?



--------------------
"Он знает: надо смеяться над тем, что тебя мучит, иначе не сохранишь равновесия, иначе мир сведет тебя с ума" - Над кукушкиным гнездом
PM MAIL ICQ   Вверх
mark2009
Дата 8.10.2012, 13:36 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Шустрый
*


Профиль
Группа: Участник
Сообщений: 106
Регистрация: 12.10.2009

Репутация: нет
Всего: 1



А в чём "не проходит"? Что за ошибка?
PM MAIL WWW ICQ Skype   Вверх
Ripper
Дата 8.10.2012, 16:01 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Lonely soul...
**


Профиль
Группа: Участник
Сообщений: 920
Регистрация: 30.6.2004
Где: г. Москва

Репутация: 1
Всего: 23



Ну вот что выдает команда "phpdoc -f users.php -t docs"
Parameter $id could not be found in getUserInfo()

Документация генерится но в ф-ии не указаны параметры. 
А вот собственно код:
Код

    /**
     * Получить информацию о пользователе
     * 
     * @param int $id идентификатор пользователя
     * 
     * @return array массив полей о пользователе 
     */
    public function getUserInfo() {
               ...
        }





--------------------
"Он знает: надо смеяться над тем, что тебя мучит, иначе не сохранишь равновесия, иначе мир сведет тебя с ума" - Над кукушкиным гнездом
PM MAIL ICQ   Вверх
  
Ответ в темуСоздание новой темы Создание опроса
Правила форума "PHP"
Aliance
IZ@TOP
skyboy
SamDark
MoLeX

Новичкам:

  • PHP редакторы собираются и обсуждаются здесь
  • Электронные книги по PHP, документацию можно найти здесь
  • Интерпретатор PHP, полную документацию можно скачать на PHP.NET

Важно:

  • Не брезгуйте пользоваться тегами [code=php]КОД[/code] для повышения читабельности текста/кода.
  • Перед созданием новой темы воспользуйтесь поиском и загляните в FAQ
  • Действия модераторов можно обсудить здесь

Внимание:

  • Темы "ищу скрипт", "подскажите скрипт" и т.п. будут переноситься в форум "Web-технологии"
  • Темы с именами: "Срочно", "помогите", "не знаю как делать" будут УДАЛЯТЬСЯ

Если Вам понравилась атмосфера форума, заходите к нам чаще! С уважением, IZ@TOP, skyboy, SamDark, MoLeX, awers.

 
0 Пользователей читают эту тему (0 Гостей и 0 Скрытых Пользователей)
0 Пользователей:
« Предыдущая тема | PHP: Общие вопросы | Следующая тема »


 




[ Время генерации скрипта: 0.0402 ]   [ Использовано запросов: 22 ]   [ GZIP включён ]


Реклама на сайте     Информационное спонсорство

 
По вопросам размещения рекламы пишите на vladimir(sobaka)vingrad.ru
Отказ от ответственности     Powered by Invision Power Board(R) 1.3 © 2003  IPS, Inc.