如何解释Javadoc中公共类的提议

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

---

您能给出javadoc的每个类、方法和字段的示例吗？

如果您使用

Eclipse

，请在要记录的方法或类声明之前键入

/**

，然后按enter键。
对于每个方法/类，将显示相应的注释，您可以编写方法/类的详细信息。

---

按此区域内的

ctrl+space

，您可以看到所有可用的

@

选项，用于文档编制

如果您使用

Eclipse

，则在要文档化的方法或类声明之前键入

/**

，然后按enter键。
对于每个方法/类，将显示相应的注释，您可以编写方法/类的详细信息。
按此区域内的

ctrl+space

，您可以首先看到所有可用的

@

用于文档编制的选项

标准方法是：

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

标准是：

在

.java

文件的顶部，包括版权许可证

导入后，包括类JavaDoc，这从行的描述开始，您可以对段落使用标签，对代码示例使用标签

• 然后添加

  @author

  标记，每个作者一个，这通常是您的全名。这是必需的

• 之后，您就有了

  @version

  标记，这是必需的

• 之后，通常会有类似于

  @的标记，请参见
  （指其他相关的类）
  

• 然后是

  @since

  ，这是您支持的第一个Java版本

举个好例子。

首先

标准方法是：

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

标准是：

在

.java

文件的顶部，包括版权许可证

导入后，包括类JavaDoc，这从行的描述开始，您可以对段落使用标签，对代码示例使用标签

• 然后添加

  @author

  标记，每个作者一个，这通常是您的全名。这是必需的

• 之后，您就有了

  @version

  标记，这是必需的

• 之后，通常会有类似于

  @的标记，请参见
  （指其他相关的类）
  

• 然后是

  @since

  ，这是您支持的第一个Java版本

---

举个好例子。

谢谢你的解释。如果有类似字符串name=“Myname”的字段；它是公共参数吗？抱歉，如果问题与min主题无关。是。如果您还有任何问题，请打开新的问题或查看我链接到的第一页。如果这个答案解决了你的问题，请考虑接受它。谢谢你的解释。如果有类似字符串name=“Myname”的字段；它是公共参数吗？抱歉，如果问题与min主题无关。是。如果您还有任何问题，请打开新的问题或查看我链接到的第一页。如果这个答案解决了你的问题，请考虑接受它。