对于类:为我的类设置概述和描述

时间:2012-10-06 23:41:55

标签: java eclipse javadoc

当你在eclipse中使用任何类或任何函数时,会出现一个小对话框,它会显示有关你选择的类或函数的一些信息。

我的问题是:如何为我的课程和职能做同样的事情?我一直无法找到有关如何执行此操作的任何信息。

示例:

对于课程:ArrayList

允许使用所有元素,包括null

  

这个类是您默认的List实现的不错选择。   Vector同步所有操作,但不一定是某种方式   这对你的应用程序有意义:将每个调用同步到get,   例如,不等于同步列表和迭代   在它(这可能是你的意图)。 CopyOnWriteArrayList是   旨在用于非常高并发,频繁的特殊情况   遍历和非常罕见的突变。

     

摘要

对于函数:Log.d()

  

public static int d(String tag,String msg,Throwable tr)自:API   级别1发送DEBUG日志消息并记录异常。

     

参数标记用于标识日志消息的来源。它通常标识发生日志调用的类或活动。    msg 您要记录的消息。    tr 日志

的例外情况

1 个答案:

答案 0 :(得分:3)

如果将Javadoc注释添加到类,方法和变量中,Eclipse应该为它们弹出本地帮助,就像内置类一样。您可以阅读有关如何编写Javadoc工具here的文档。