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

Question

Я большой поклонник автоматического создания комментариев GhostDoc в Visual Studio, поэтому ищу плагин, который выполняет ту же работу с моим Java-кодом в Eclipse. Любые рекомендации?

Answer 1

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

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

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

Answer 2

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

ALT + Сдвиг + J

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

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

Answer 3

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

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

Answer 4

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

Пример:

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

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

Answer 5

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