如何向方法或类添加描述

Question

如何在Java中添加方法描述？我使用NetBeans IDE。

Answer 1

使用javadoc评论 - / **这是评论* /

请查看此链接以获取详细文档http://en.wikipedia.org/wiki/Javadoc

Answer 2

您可以使用/ ** comments * /

来使用javadoc

对于基本上你可以有

的方法

/**
The Desciption of the method to explain what the method does
@param the parameters used by the method
@return the value returned by the method
@throws what kind of exception does this method throw
*/

您可以使用此链接获取更多帮助http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#descriptions

Answer 3

在您的方法之上编写注释应该按照您的意愿执行 示例：

/** 
This method does some serious stuff 
*/
public int getN()
{
return n;
}

如果你使用javadocs，它应该是方法的描述。

Answer 4

请参阅guide并查看source code of some of the standard Java classes。

Answer 5

一切都在这里： http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/index.html

我正在添加这句话，因为我上面的回答太短了。 ： - ）

Answer 6

我想IDE正在寻找源文件中的javadoc定义。因此，您需要将源附加到项目中使用的库。

Answer 7

@Description("method name")
methodName<String> getset(){...}

@Description("class name")
class ClassName{..}