What are docstrings called in java?

28,851

Solution 1

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).

Solution 2

Yup, it's called javadoc.

Share:
28,851
tttppp
Author by

tttppp

Updated on April 25, 2020

Comments

  • tttppp
    tttppp about 4 years

    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)?