javaDoc

以/**开头，以*/结尾的内容叫作javaDoc。

它可以放在类的定义前，也可以放在方法或字段的定义前。

例如

/**RestTemplate使用方法示例
 * @see org.springframework.web.client.RestTemplate
 */
public class MyClient {}

若类B在另一个源文件中，它调用了MyClient类，那么在ide中，鼠标放在调用处，就会有一个小浮窗展现javaDoc的内容。效果见图1：

图1：ide中的javaDoc

javaDoc支持html标签。除此之外，还有一些@开头的标签。

@see：表示链接到其他类、方法、字段的javaDoc。