What are docstrings called in java?

java documentation-generation nomenclature
tttppp picture tttppp · Sep 16, 2010 · Viewed 23.4k times · Source

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

Answer

Buhake Sindi picture Buhake Sindi · Sep 16, 2010

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

Related questions

Should I include getters & setters in class diagram?

I am required to draw a class diagram for my JSF application for a project documentation. So I have lots of classes as managed beans, with many attributes therefore many getters and setters. When I draw the class diagram should …

Read More
How to apply new line in docx file generation using DOCX4J

By the tutorials that I have seen. I learned how to add text on generating a docx file. but then Every time I add a line of text. I noticed that there is always a space between the first line …

Read More
How do I convert a String to an int in Java?

How can I convert a String to an int in Java? My String contains only numbers, and I want to return the number it represents. For example, given the string "1234" the result should be the number 1234.

Read More