有没有办法将所有评论转换成 javadoc 评论？ [日食/Java]

Posted 2023-02-21

【中文标题】有没有办法将所有评论转换成 javadoc 评论？ [日食/Java]

【英文标题】：Is there a way to convert all comments into javadoc comments? [Eclipse/Java]

【发布时间】：2020-10-28 08:52:20

【问题描述】：

我正在使用 Eclipse 做 Java 学校作业，在最底部它说所有文档都应该在 Javadoc 中，但我已经使用 // 完成了所有 cmets。

除了手动返回并将每条评论更改为 Javadoc 格式 /** */ 之外，还有其他更简单的方法吗？

谢谢。

【参考方案1】：

Javadocs 是一种特定的注释格式，用于为您的代码生成外部文档。您不应该将常规 cmets 转换为 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。

但是，如果您确实想转换 cmets，则必须像您说的那样手动进行。对此没有特定的工具。

【讨论】：

我明白了，例如：/** Setting greatestCost to the index of the most expensive transport*/ for(int i = 0; i < 15; i++) if(allTransports[greatestCost].getTicketPrice() < allTransports[i].getTicketPrice()) greatestCost = i; 这是对 Javadoc 的正确使用，还是应该改用 //？

该死的没有按照我的计划出现。本质上，如果我的评论是/** Setting greatestCost to the index of the most expensive transport*/

不，那将是常规评论。 Javadoc 用于***文档，例如类、方法和字段。永远不要在方法内部。我链接的技术文档应该会有很大帮助。