如何制作我的程序的 JAVADOC？

Posted 2023-04-18

【中文标题】如何制作我的程序的 JAVADOC？

【英文标题】：How to make a JAVADOC of my program?

【发布时间】：2018-05-31 07:56:52

【问题描述】：

这是我的代码：

public class Client

   protected int cod;
   protected String name;

   public void setCod(int cod) throws Exception
   
      if(cod==null)
      throw new Exception("Invalid code!");

      this.cod = cod;
   

   public int getCod()
   
      return this.cod;
   

   public void setName(String name) throws Exception
   
      if(name==null || name.equals("")
      throw new Exception("Invalid name!");

      this.name = name;
   

   public String getName()
   
      return this.name;
   

   public Client(int cod, String name) throws Exception
   
      this.setCod(cod);
      this.setName(name);
   

   public boolean equals(Object obj)
   
      if(this==obj)
      return true;

      if(obj==null)
      return false;

      if(!(obj instanceof Client))
      return false;

      Client client = (Client)obj;

      if(this.cod!=client.cod)
      return false;

      if(this.name!=client.name)
      return false;

      return true;
   

   public String toString()
   
      return "Code: " + this.cod + "\n" +
             "Name: " + this.name;
   

   public int hashCode()
   
      int ret = 444;

      ret += ret*7 + new Integer (this.cod).hashCode();
      ret += ret*7 + (this.name).hashCode();

      return ret;
   

   public Object clone()
   
      Client ret = null;

      try
      
         ret = new Client(this);
      
      catch(Exception error)
      
       // this is never null 
      

      return ret;
   

   public Client(Client model) throws Exception
   
      if(model==null)
      throw new Exception("Inexistent model!");

      this.cod = model.cod;
      this.name = model.name;
   

我知道，要发表评论，您必须输入“//”或“/*”和“*/”。但是我怎样才能按照 JAVADOC 规则发表评论呢？ 如果你知道怎么做，你能用 JAVADOC 复制我的代码并把它放在你的答案中吗？谢谢:) 请告诉我，什么是 JAVADOC，它的用途是什么？有什么简单的制作方法吗？

【问题讨论】：

Look it up :)

如果您不熟悉该主题，那么在尝试编写任何文档之前，您真的应该考虑阅读有关 javadoc 的内容。

也许以How to Write Doc Comments for the Javadoc Tool 开头，大多数IDE 都有一些有助于生成JavaDoc cmets 的功能，也许也可以探索这些。至于它有什么用 - if you've never visited the API documentation 那么你就是在伤害自己。 IDE 还可以使用您的代码和第三方代码中的 JavaDocs 在您编码时生成更多信息和建议

为什么我有-6分？我诅咒别人了吗？

所以 f1sh 是有史以来最好的程序员

【参考方案1】：

Javadoc 是您在程序中使用的一种注释，用于组织它，使程序更友好，并使用您注释的所有内容创建一个页面 html，如下所示：

因此，要创建一个 javadoc，您需要将 /** 放在首位，而不是 /*。 在创建 javadoc 时需要了解一些命令类型。

@author - 谁创建了程序 @throws - 用于异常 @param - 方法参数 @return - 方法返回什么

因此，您的 javadoc 代码将如下所示：

/**
  * @author IncredibleCoding
  */
public class Client

protected int cod;
protected String name;

/**
  * instance the code passed
  */
public void setCod(int cod) throws Exception

  if(cod==null)
  throw new Exception("Invalid code!");

  this.cod = cod;


/**
  * @returns the code
  */
public int getCod()

  return this.cod;


/**
  * instance the name passed
  * @param name, that is the name passed
  * @throws Exception, if the name is in invalid format
  */
public void setName(String name) throws Exception

  if(name==null || name.equals("")
  throw new Exception("Invalid name!");

  this.name = name;


/**
  * @returns the name 
  */
public String getName()

  return this.name;


/**
  * the constructor
  * @param cod, that is the code passed
  * @param name, that is the name passed
  */
public Client(int cod, String name) throws Exception

  this.setCod(cod);
  this.setName(name);


/**
  * @param obj, that is the object that will be compared
  * @returns true if the object is equal to this, false if the object isn't equal
  */
public boolean equals(Object obj)

  if(this==obj)
  return true;

  if(obj==null)
  return false;

  if(!(obj instanceof Client))
  return false;

  Client client = (Client)obj;

  if(this.cod!=client.cod)
  return false;

  if(this.name!=client.name)
  return false;

  return true;


/**
  * returns the formatted variable like String
  */
public String toString()

  return "Code: " + this.cod + "\n" +
         "Name: " + this.name;


/**
  * returns the hashCode of a variable
  */
public int hashCode()

  int ret = 444;

  ret += ret*7 + new Integer (this.cod).hashCode();
  ret += ret*7 + (this.name).hashCode();

  return ret;


/**
  * clone the object
  */
public Object clone()

  Client ret = null;

  try
  
     ret = new Client(this);
  
  catch(Exception error)
  
   // this is never null 
  

  return ret;


/**
  * "copy" the variables
  * @param model, that is the object that will be copied
  * @throws Exception, if the model is inexistent
  */
public Client(Client model) throws Exception

  if(model==null)
  throw new Exception("Inexistent model!");

  this.cod = model.cod;
  this.name = model.name;

你应该考虑看看这个 ORACLE 的页面，这对你也有帮助：https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html