什么是java中调用的文档字符串？

Question

在Java方法之前,我们有类似的东西:

/**
 * 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) {
...
}

这是否有名称(如Python中的docstrings)？

Answer 1

实际上,它们被称为文档注释,而javadoc是一种将这些注释生成为HTML的工具.

您可以在Wikipedia中找到Javadoc注释的结构(例如).

Answer 2

是的,它被称为javadoc.