Question

我想学习在课堂上编写方法定义。即：

    public int myMethod()
    {
    //This method is used for ....bla bla bla....
    }

我想告诉用户有什么方法可以做。在.Net中，您可以编写此定义，并在编写方法时看到解释。如何在JAVA中完成？

Answer 1

这样做：

/**
* This method is used for..
*/
public int myMethod()
{

}

对于params使用如下：

/**
* This method is used for..
* @param v pass this to do something
*/
public int myMethod(Object v)
{

}

此处详细说明：oracle.com

Answer 2

充实其他一些答案。

第一句话应该是第三人称的陈述句，它回答了“方法做什么”的问题，e.q。，“创造一个foobar”。此外，第一句用作摘要注释，因此它应尽可能清晰，简洁。

例如，如果您的方法读入文件并返回整数状态：

/**
 * Reads in config file and initializes application.
 *
 * @return Application status; 0 if everything is okay.
 */
public int myMethod() {
    // ...
}

IMO添加不必要的细节只是 - 不必要。有些方法是自我记录的，规范的例子是getter / setter：

/**
 * Sets first name.
 *
 * @param firstName Name to set.
 */
public void setFirstName(String firstName) {
    this.firstName = firstName;
}

冗余评论。同样，命名良好的方法可以避免需要大量或任何文档：

public List<User> getAllUsers() { ... }
public User findUserById(Long id) { ... }

国际海事组织，除非事情非常显着，否则没有必要说明。

HTML用于标记Javadocs，但IMO最好将其格式化为可以多种格式（编辑器，IDE，Javadoc等）读取，因此我倾向于缩进并使用空格确保我能以纯文本和呈现方式查看所有内容。

标准doclet假定HTML：忽略空格，除非通过<p>或<br>标记明确说明。

/**
 * Builds and returns the current list of ingredients.
 *
 * <p>
 *   <b>Note:</b> Initializes ingredient information if necessary.
 * </p>
 */

有用的链接：

javadoc program docs
How to write javadocs
Requirements for writing Java API specs
My own take on Javadocs and documentation in general（包括一些较少使用的Javadoc技巧）

Answer 3

如果必须记录函数，则在函数前使用Javadoc是有利的。

/**
 * Does [fill in the blank here]
 * @return An integer stating [what it does]
 */
public int myMethod() {
    // Fill in the rest here
}

Answer 4

将其添加为方法上方的/ ** ... * /注释：

/**
*  This method is used for ....bla bla bla....
*/
public int myMethod()
{

}

一旦键入/ **，Eclipse将自动生成Javadoc方法签名注释，然后按Enter键转到下一行。

Answer 5

见How to Write Doc Comments for the Javadoc Tool。（基本上，你正在寻找所谓的Javadocs。）

请参阅此处发布的其他答案以获取一些示例。

Answer 6

您需要使用javadoc注释来实现此目的。像下面的东西

/** * This method is used for.. */ public int myMethod() {  }

以下是有关Javadoc方法Javadoc methods

的更多信息的链接

Java编写方法定义

6 个答案: