Java'；项目经理；？（评论、课堂视图等）

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

评注通常包括：

@param

@return

{@link *classname*}

等等

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

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

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

单击“窗口”->“视图”->“其他”->键入“javadoc”

打开JavaDoc视图。该视图向您展示了文档最终将如何呈现

现在打开任何类，在类定义顶部键入“/**”，然后按enter键。您将看到如下内容：

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

它的行为类似于多行注释，但始终以双星号开头。让卡雷特在这个区块内，保持crtl和命中空间。它将向您显示所有可用于标记文档的允许标记。写一个“@”符号，并用同样的方法查看所有预定义的javadoc标记。添加其中一些，看看JavaDoc视图是如何变化的

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

阅读和