Java 'project manager'？ (评论、类观点等...)

Question

阅读一些开源 Java 项目的文件后，我开始思考，我没有利用当前开发人员工具所提供的所有优势。

评论通常包括:

@param

@return

{@link *classname*}

等等

这是“唯一”的良好风格/最佳实践，还是意味着开发人员使用某种工具来使其代码更易于其他人阅读？如果是这样，您能给我一些建议吗？

我目前正在使用 eclipse 的一个相当轻量级的版本，并认为这已经足够了，但如果这是使用此类工具的常见方法并且大多数程序员都使用它，那么可能有充分的理由。

Answer 1

这就是 JavaDoc 。它是一种为 Java 类创建文档的语法。由于您仍在使用 Eclipse，请执行以下操作:

1. 点击“窗口”->“ View ”->“其他”-> 输入“javadoc”。
2. 打开 JavaDoc View 。此 View 向您展示了文档最终将如何呈现。

现在打开任何类并在类定义顶部键入“/**”，然后按 Enter 键。您将看到类似这样的内容:

/**
 *
 */
public class MyClass ...

它的行为类似于多行注释，但始终以双星号开头。将卡雷特放在该 block 内，按住 crtl 并按空格键。它将向您显示可用于标记文档的所有允许的标签。编写“@”符号并执行相同操作以查看所有预定义的 javadoc 标记。添加其中一些，并查看 JavaDoc View 如何变化。

完成后，单击“项目”->“生成 JavaDoc”->“完成”。您的项目中会有一个名为“docs”的文件夹，您可以在其中找到文档。在浏览器中打开index.html。