如何制作我的程序的 JAVADOC?

难以置信的编码

这是我的代码

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 是您在程序中使用的一种注释,用于组织它,使程序更友好,并使用您注释的所有内容创建页面 HTML,如下所示: javadoc 页面示例

因此,要创建一个 javadoc,您需要使用 top/**代替/*. 在创建 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

本文收集自互联网,转载请注明来源。

如有侵权,请联系[email protected] 删除。

编辑于
0

我来说两句

0条评论
登录后参与评论

相关文章

来自分类Dev

从JavaDoc制作Bitbucket源Wiki

来自分类Dev

JAXB:如何生成英语Javadoc

来自分类Dev

如何为Javadoc注释上色

来自分类Dev

如何为多个模块的javadoc

来自分类Dev

如何生成正确的javadoc参考?

来自分类Dev

如何通过Gradle Javadoc任务完成从JDK继承Javadoc注释?

来自分类Dev

如何在我的javadoc示例中编写块注释?

来自分类Dev

如何告诉javadoc我的句号没有结束

来自分类Dev

Javadoc:如何修复:“错误的HTML实体”错误

来自分类Dev

如何获取JavaDoc for Eclipse插件开发?

来自分类Dev

如何为getInstance方法编写Javadoc?

来自分类Dev

如何在JavaDoc中包含@Annotations?

来自分类Dev

如何在JavaDoc中插入创建日期

来自分类Dev

混淆后如何保持javadoc可见

来自分类Dev

如何为类似功能重用javadoc

来自分类Dev

如何排除Javadoc ant脚本上的文件

来自分类Dev

如何强制SBT使用Javadoc代替Scaladoc?

来自分类Dev

如何在Javadoc中插入标签('>';'<')

来自分类Dev

如何为类似功能重用javadoc

来自分类Dev

如何强制SBT使用Javadoc代替Scaladoc?

来自分类Dev

Javadoc:如何修复:“错误的HTML实体”错误

来自分类Dev

是否可以在我的UI中复制并显示Oracle API Javadoc

来自分类Dev

可以在我的UI中复制并显示Oracle API Javadoc吗

来自分类Dev

JavaDoc错误,发布了我的第一个文档

来自分类Dev

反编译的《我的世界》源代码的javadoc注释在哪里?

来自分类Dev

我如何制作可重复的程序

来自分类Dev

Android Studio 0.8.2如何附加Javadoc支持库

来自分类Dev

如何将Javadoc嵌入到Netbeans的Jar中

来自分类Dev

每当有特定注释时,如何使Checkstyle忽略缺少的JavaDoc