как мне задокументировать использование GET или POST в методе контроллера?

Я ищу лучший способ документирования моих методов контроллера в php. Мне было интересно, как я должен документировать свои требования POST и GET (здесь я использовал REQUEST, чтобы показать, что мне это нужно для обоих способов).

см. этот метод:

public function login(){

    $username = $_REQUEST['username'];
    $password = $_REQUEST['password'];
    $stay_loggedin = $_REQUEST['stay-loggedin'];

    $user = new usermodel();
    if ($user->login($username, $password, $stay_loggedin) ) return <something>;
    else return page_not_allowed;
}

Было бы здорово, если бы кто-нибудь подсказал мне способ, совместимый с php-doc... Я имею в виду, что @param не будет правильным путем, не так ли?

Должен ли я также задокументировать требуемый класс модели пользователя? И как?

Спасибо за вашу помощь


php documentation phpdoc
person helle    schedule 22.02.2012    source источник
comment
Вы видели это: stackoverflow.com/questions/2121710/   -  person Sudhir Bastakoti    schedule 22.02.2012
comment
нет, не видел, но просмотрел все предложения...   -  person helle    schedule 22.02.2012
comment
Что ж, тогда, пожалуйста, проверьте это и это тоже: /1269086/параметры-запроса-и-phpdoc   -  person Sudhir Bastakoti    schedule 22.02.2012
comment
Я не понимаю, что написано в первой ссылке, которую вы разместили   -  person helle    schedule 22.02.2012

Ответы (1)


arrow_upward
1
arrow_downward

Для документирования методов GET/POST вы можете сделать следующее:


/**
 * Function to Login a user
 *
 * Requires $_POST['username'] and $_POST['password']
 * Optional $_REQUEST['stay-loggedin'] 
 * 
 * @return void
 */
public function login(){

    $username = $_REQUEST['username'];
    $password = $_REQUEST['password'];
    $stay_loggedin = $_REQUEST['stay-loggedin'];

    $user = new usermodel();
    if ($user->login($username, $password, $stay_loggedin) ) return ;
    else return page_not_allowed;
}

И вы можете задокументировать класс модели пользователя в самом файле класса модели пользователя. Надеюсь, поможет

person Sudhir Bastakoti    schedule 22.02.2012
comment
есть ли плагин, который автоматически создает что-то подобное в netbeans? - person helle; 22.02.2012