生成Javadoc

Question

我正在努力的任务要求：

合理的内联代码文档，提供Javadoc生成的文档，包含方法描述，参数和返回值描述。

这不就是/ **吗？或者它是eclipse生成的版本吗？

Answer 1

他们只是要求对代码进行适当的评论，以便以后可以通过javadoc工具提取文档。您应该遵循所有Javadoc best practices，当然如果您想要额外的功劳，请运行构建的文档阶段以实际生成文档。我相信他们会喜欢这个。

Answer 2

“Javadoc生成的文档”将是从代码中的/**注释生成的HTML文档。我不知道eclipse是否具有该功能，但通常使用JDK附带的javadoc命令行工具来完成。