Java‘项目经理’？(注释、类视图等...)

Question

阅读了几个开源java项目的文件后，我开始思考，我并没有使用当前开发工具所提供的所有优势。

评论通常包括：

@param

@return

{@link *classname*}

等。

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

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

Answer 1

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

窗口视图单击"Window“-> "Views”->“Other”-> type "javadoc".

• Open JavaDoc 。此视图显示文档的最终呈现方式。

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

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

它的行为类似于多行注释，但始终以双星号开头。将carret放在这个块中，按住crtl键并按空格键。它将显示您可以用来标记文档的所有允许的标记。编写一个"@“符号，然后执行相同的操作，以查看所有预定义的javadoc标记。添加其中的一些，看看JavaDoc视图是如何变化的。

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