Java“项目经理”？ （评论，课堂视图等......）[关闭]

Question

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

评论通常包括：

@param

@return

{@link *classname*}

等等

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

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

Answer 1

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

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

现在打开您的任何类并在类定义的顶部键入“/**”，然后按 Enter。你会看到这样的东西：

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

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

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