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

2 Answers

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

Yup, it's called javadoc.

5

Your Answer

Sign up or log in

Sign up using Google Sign up using Facebook Sign up using Email and Password

Post as a guest

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy