0

嗨，我被要求解释我程序中每个公共类、公共方法和公共字段的用途，但我不知道该写什么，例如@param 仅用于方法？

你能举一个javadoc的每个类、方法和字段的例子吗？

4

2 回答 2

3

首先是 oracle 教程。

标准方法是：

/**
* This class does XYZ, here goes a description of your class
* @author Alex Jj
* @version 1.0
*/

标准是：

在.java文件的顶部，包括版权许可。

导入后，包含 JavaDoc 类，这从对行的描述开始，您可以使用<p>段落、<code>代码示例等标签。

  • 然后你添加@author标签，每个作者一个，这通常是你的全名。这是必需的。

  • 之后，你有@version标签，这是必需的

  • 之后，您通常会有类似的标签@see（指其他相关的类）

  • 其次@since是您支持的第一个 Java 版本

一个很好的例子是 java.lang.String 是如何记录的。

于 2013-03-31T13:25:28.233 回答
2

如果您使用Eclipsethen 键入/**并在要记录的方法或类声明之前按 Enter。
对于每个方法/类，将出现相应的注释，您可以编写方法/类的详细信息。
通过在此区域内按下ctrl+space，您可以查看所有可用@选项以用于文档目的

于 2013-03-31T13:16:42.030 回答