如何在Android Studio中为我的类和方法创建文档?

时间:2014-10-02 19:46:06

标签: android eclipse ide documentation android-studio

我是android世界的新手,我想知道是否有办法将文档提供给我的班级,所以当我将鼠标悬停在类对象上时,我将能够检索如下图所示的描述< / p>

enter image description here

在视觉工作室中,我所要做的就是这样:

    /// <summary>
    /// This is the Documentation 
    /// </summary>

我已经尝试了这个并且它没有工作

2 个答案:

答案 0 :(得分:2)

您正在谈论的名为JavaDoc的功能:

/**
* This method adds two numbers
* @param a my param a
* @param b my param b
* @return result description
*/
public int add(int a, int b){
......

详情here

答案 1 :(得分:1)

javadoc。你应该输入

/**
 *
 */

在方法声明之前

Here您可以找到更多信息