有没有一种方法可以将所有注释转换为javadoc注释？ [Eclipse / Java]

Question

我正在用Eclipse进行Java学校作业，最开始它说所有文档都应该在Javadoc中，但是我已经使用//做了所有注释。

除了手动返回并将每个注释更改为Javadoc格式/** */之外，还有其他简便的方法吗？

谢谢。

Answer 1

Javadocs是一种特定的注释格式，用于为您的代码生成外部文档。您不应该将常规注释转换为Javadoc。

例如：

/**
 * Do foo with a.
 * @param a the a value
 * @return some different value
 * @see #bar
 */
public String foo(String a) {
    // blah blah blah
}

有关更多详细信息，请参见this technical doc。

但是，如果您确实要转换注释，则必须像您所说的那样手动进行。没有特定的工具。

Answer 2

单行注释（//）和Javadoc注释（/ ** * /）的设计具有区别性，并解决了不同的目的。 Javadoc注释用于创建文档API，并且可以应用于字段/方法/类。

但是，如果仍然要先执行操作，则需要切换Comment（Ctrl + /）来删除或添加评论，然后将Javadoc Comment（Alt + Shift + J）指定到活动字段/方法/类。

插入的Javadoc注释基于在窗口>首选项> Java>代码样式>代码模板下定义的代码模板。如果展开“注释”部分，则可以更改“字段”，“方法”，“类”等的默认值。