JavaDoc用于重载方法,这些方法只调用同一个方法,但具有空值?

JavaDoc用于重载方法,这些方法只调用同一个方法,但具有空值?,java,overloading,javadoc,Java,Overloading,Javadoc,因此,我正在为重载方法编写JavaDoc,我无法找到格式化它们的最佳方法。我的项目是一个医生预约查看系统,具有以下功能: 医生对象具有约会对象的LinkedList 可以创建包含患者姓名和日期的预约对象 用户可以作为医生登录 用户可以列出约会 用户可以创建新约会 因此,我的系统中的一个例子是Doctor对象中名为“isAvailable(Date)”的方法。该方法接受一个日期参数,然后检查Doctor对象中的所有约会对象,以查看该医生是否在该日期可用。如果是,将创建一个新的约会对象并将其添加

因此,我正在为重载方法编写
JavaDoc
,我无法找到格式化它们的最佳方法。我的项目是一个医生预约查看系统,具有以下功能:

  • 医生对象具有约会对象的LinkedList
  • 可以创建包含患者姓名和日期的预约对象
  • 用户可以作为医生登录
  • 用户可以列出约会
  • 用户可以创建新约会
因此,我的系统中的一个例子是Doctor对象中名为“isAvailable(Date)”的方法。该方法接受一个日期参数,然后检查Doctor对象中的所有约会对象,以查看该医生是否在该日期可用。如果是,将创建一个新的约会对象并将其添加到该医生的LinkedList中

现在,我有一个重载的
isAvailable(stringdate)
方法,它执行以下操作:

  • 将日期作为字符串类型
  • 从字符串日期解析日期对象
  • 使用解析的日期对象调用isavailable(Date)
我是应该为这两个文件编写JavaDoc,并假装isAvailable(字符串日期)执行检查医生是否可用的功能,还是应该说它只是将字符串转换为日期,然后调用isAvailable(日期)

谢谢。

怎么样

 /**
  * Parses the argument into a Date object, then calls {@link Doctor#isAvailable(Date)}
  */