Эквивалент GhostDoc для Eclipse (Java)

Ответ 1

Это в основном эквивалент Javadoc, который может генерировать в eclipse ярлык:

ALT + Shift + J

(когда вы находитесь в пределах функции Java, для которой вы хотите добавить javadoc)

Оттуда, если вы действительно хотите формат XML, вы можете попробовать использовать JELDoclet

Ответ 2

Вы можете проверить JAutodoc (http://jautodoc.sourceforge.net/)
От автора:

JAutodoc - это плагин Eclipse для автоматически добавление Javadoc и файла заголовки к исходному коду. Это необязательно генерирует исходные комментарии от имени элемента, используя Velocity шаблоны для Javadoc и файл заголовки.

Это тот, который я нашел ближе всего к GhostDoc.

Ответ 3

GhostDoc имеет приятную дополнительную функцию, которая описывает описание метода, анализируя имя метода и предоставляя его в виде скелетной документации. Например, использование GhostDoc для метода с именем GetDocumentName() может вернуть фразу "Получить имя документа". Хотя это вряд ли больше информации, чем указано в имени метода, она добавляет документацию по методу, где ранее не существовало. Некоторые могут утверждать, что это едва полезно. Я утверждаю обратное, потому что он поддерживает создание документации из исходного кода (например, для таких инструментов, как NDoc или SandCastle).

По моему мнению, наибольшая выгода GhostDoc над eclipse "Generate Element Comment" заключается в том, что он поощряет программистов начинать добавлять комментарии к документации, добавляя чрезвычайно быстрый и надежный способ создания этого. Программист может принять выводный текст (подходит в 50 - 80% случаев) или расширить его для более сложных методов. Для младшего программиста, который не так хорошо знаком с тем, как используются комментарии к документации, это может быстро сократить кривую обучения и поощрить хорошие методы программирования.

Ответ 4

Javadoc не похож на GhostDoc мой друг. Javadoc только создает структуру, поэтому можно писать документацию с нуля. GhostDoc фактически заполняет информацию в соответствии с именем Method/Property.

Пример:

/// <summary>
/// Gets the user from id.
/// </summary>
/// <param name="id">The id.</param>
/// <returns></returns>
private string GetUserFromId(string id);

JAutoDoc является самым близким, которого я нашел до сих пор, но он не так волшебным, как GhostDoc.

Ответ 5

Никогда не использовал GhostDoc, поэтому не уверен, какую дополнительную функциональность он дает, но если он будет генерировать комментарии типа и метода на основе имени, параметров, типа возврата и т.д., тогда eclipse будет встроен, поэтому никаких расширений не потребуется.