Java＆＃39;项目经理＆＃39;？ （评论，课堂观点等......）

Question

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

评论通常包括：

@param

@return

{@link *classname*}

等

只是这个＆＃39;好的风格/最佳实践还是这样做意味着开发人员使用某种工具来使他的代码更容易为他人阅读？如果是这样，你能开始给我一些建议吗？

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

Answer 1

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

1. 点击＆＃34; Window＆＃34; - ＆GT; ＆＃34;浏览＆＃34; - ＆GT; ＆＃34;其他＆＃34; - ＆GT;输入＆＃34; javadoc＆＃34;。
2. 打开JavaDoc视图。此视图显示了文档最终将如何呈现。

现在打开你的任何课程并输入＆＃34; / **＆＃34;在类定义的顶部并按Enter键。你会看到这样的东西：

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

它的行为类似于多行注释，但始终以双星号开头。将carret放在这个区域内，保持crtl并击中空间。它将显示您可用于标记文档的所有允许标记。写一个＆＃34; @＆＃34;签名并执行相同操作以查看所有预定义的javadoc标记。添加其中一些，看看JavaDoc视图是如何变化的。

完成后，点击＆＃34;项目＆＃34; - ＆GT; ＆＃34;生成JavaDoc＆＃34; - ＆GT; ＆＃34;完成＆＃34 ;.您的项目中将有一个名为＆＃34; docs＆＃34;的文件夹。在哪里可以找到文档。在浏览器中打开index.html。