Question

我正在为我的一些代码编写javadoc注释，但我遇到了一个问题。当我“鼠标悬停”我记录的一个函数时，我能够看到我在javadoc注释中写的描述，但是当我将鼠标悬停在标准库函数（如System.out.println()上时，它看起来并不相同。鼠标悬停的给定功能如下所示：

的println
public void println()
这里的描述

但是虽然我的函数在javadoc视图中以非常类似的方式出现，但在鼠标悬停时，它们不会像上面的示例那样自动格式化，只显示注释中的描述。我想知道如何能够让我的javadoc评论在鼠标上也显示出来。

Answer 1

实际上有一个完整的标记用于编写JavaDoc而不仅仅是纯文本描述。看起来不同的原因是因为他们使用标记使它看起来更好。以下是来源的一个例子：

/**
* Prints a String and then terminate the line.  This method behaves as
* though it invokes <code>{@link #print(String)}</code> and then
* <code>{@link #println()}</code>.
*
* @param x  The <code>String</code> to be printed.
*/
public void println(String x) {
   synchronized (this) {
      print(x);
      newLine();
   }
}

请注意使用@param和@link等标记。这是Oracle编写标记的指南：http://www.oracle.com/technetwork/articles/java/index-137868.html

Javadoc＆＃34;鼠标移动＆＃34;视图

1 个答案: