Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
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)?
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).