JavaDoc用于重载方法，它只调用相同的方法，但具有空值？

Question

所以我正在为重载方法编写JavaDoc，我无法理解它们的最佳格式。我的项目是Doctor Appointment Viewing系统，具有以下功能：

• 医生对象具有约会对象的链接列表
• 可以创建包含患者姓名和日期的约会对象
• 用户可以以医生的身份登录
• 用户可以列出约会
• 用户可以创建新的约会

因此，我的系统中的一个示例是Doctor对象内部的一个名为'isAvailable（Date date）'的方法。该方法采用日期参数，然后检查Doctor对象中的所有Appointment对象，以查看Doctor是否可用于该日期。如果是这样，则创建一个新的Appointment对象并将其添加到该医生的LinkedList中。

现在，我有一个重载的isAvailable(String date)方法执行以下操作：

• 将日期作为字符串类型
• 从字符串日期
解析Date对象
• 使用已解析的Date对象调用isAvaialble（Date）

我是否应该为它们编写JavaDoc并假装isAvailable（String Date）执行检查Doctor是否可用的功能，或者我应该说它只是将String转换为Date然后call isAvailable（Date）？

感谢。

Answer 1

怎么样

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