В мои дни С# мне нравилось использовать расширение Visual Studio под названием "GhostDoc". Теперь, когда я использую Java-разработчик, я использую Eclipse. Я могу жить, не имея возможности выводить документацию, но что-то, что я хотел бы сделать, это разумно "исправить" мою документацию. Например, допустим, что у меня есть следующий метод:
/**
* Gets a collection of {@link Foo} objects
* @param bar The bar level
* @param baz The bazziness
*/
public Collection<Foo> getFoos(int bar, int baz)
{
// Do something cool
}
Позже в разработке я понимаю, что было бы полезно разрешить пользователям моего метода передавать значение qux. Не только это, но имеет смысл иметь его в качестве первого параметра. Кроме того, я собираюсь использовать метод throw для моего супер полезного исключения FooBarException. Итак, теперь мой метод выглядит следующим образом:
/**
* Gets a collection of {@link Foo} objects
* @param bar The bar level
* @param baz The bazziness
*/
public Collection<Foo> getFoos(String qux, int bar, int baz) throws FooBarException
{
// Do something cool
}
Будучи хорошим разработчиком, я хочу, чтобы мои изменения отражались в моем JavaDoc. В GhostDoc я мог ударить по ключевому слову моего документа, и он добавит новые вещи, не потревожая старые вещи. В Eclipse он отображает совершенно новый набор JavaDoc, и мне нужно сделать кучу копий пасты. Как я могу автоматически добавить новый @param, @exception и отсутствующий параметр @returns в свой JavaDoc без потери JavaDoc, который у меня есть в настоящее время?
