java中称为文档字符串是什么?

在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中的文档字符串一样)?


答案 1

实际上,它们被称为文档注释javadoc是将这些注释生成到HTML中的工具。

您可以在维基百科中找到Javadoc注释的结构(例如)。


答案 2

是的,它被称为javadoc


推荐