Pergunta

Before Java methods we have something like:

/**
 * Takes a number and returns its square root.
 * @param x The value to square.
 * @return The square root of the given number.
 */
public float getSqrt(float x) {
...
}

Does this have a name (like docstrings in Python)?

Foi útil?

Solução

Actually, they are called document comments and javadoc is a tool to generate those comments into HTML.

You can find the structure of the Javadoc comment in Wikipedia (for example).

Outras dicas

Yup, it's called javadoc.

Licenciado em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top