Как документировать методы doPost ()? - PullRequest
0 голосов
/ 04 ноября 2019

У меня есть метод doPost (), который может выполнять одно из двух действий:

  1. Вход в учетную запись при нажатии кнопки «Войти».
  2. Регистрация учетной записиесли нажата кнопка «регистрация».

Какой тип блока документации является стандартным для документирования этого типа взаимодействия?

См. следующий пример:

/**
 * The account class as an example.
 */
@WebServlet("/account")
public class Account extends HttpServlet {
    /**
     * What's the standard way to document
     * that registerButton and loginButton do different actions here?
     */
    protected void doPost(HttpServletRequest request, HttpServletResponse response) {
        if (request.getParameter("registerButton") != null) {
            // register stuff...
        }

        if (request.getParameter("loginButton") != null) {
            // login stuff...
        }
    }

    /**
     * An example of a documentation-block.
     * @param arg an integer example argument.
     * @return A boolean value as an example.
     */
    private boolean example(int arg) {
    }
...