Есть ли замена javadoc, которая использует синтаксис типа Wiki?

Есть ли инструмент, заменяющий javadoc чем-то более синтаксисом Wiki-стиля вместо синтаксиса HTMLish обычного JavaDoc?

Одна из моих проблем заключается в том, что я в основном читаю JavaDoc в исходной форме. Даже для внешних библиотек я пытаюсь подключить источник, чтобы я мог перемещаться по нему из своей IDE, проверяя документацию над точкой входа и, при необходимости, код ниже.

Другая проблема заключается в том, что такие вещи, как списки и образцы кода, беспорядочны, особенно если ваша среда IDE настаивает на том, чтобы помещать звезды в каждую строку. То, что я хотел бы видеть, - это то, что использует синтаксис Wiki, по меньшей мере, следующие функции:

  • списки
  • блоки кода
  • сшивание по методам/классам

Есть еще много вещей, которые были бы хороши, но я считаю, что это основные вещи.

Кто-нибудь знает о таком инструменте?

Ответы

Ответ 1

Существует проект под названием WikiDoclet, я никогда не использовал его, но мне было бы интересно посмотреть, что вы думаете о нем он.

С сайта:

Это расширение стандартного javadoc doclet, предоставляемого Java JDK. Он добавляет поддержку того, что я называю форматированием Wiki. Это означает, что ваш JavaDoc теперь может быть отформатирован с использованием текстовых правил, которые проще для глаз, чем html, встроенных в JavaDoc. Например, чтобы подчеркнуть фрагмент текста, вы окружаете его звездами. Курсив с подчеркиванием. Когда doclet запускается для создания JavaDoc, эти правила оцениваются и выполняются подстановки html. Это форматирование должно значительно облегчить чтение исходного кода java, поскольку он больше не будет загроможден HTML-тегами. Это особенно верно для маркированных списков и таблиц. Тем не менее, HTML сохраняется, поэтому вы можете смешивать и сопоставлять по своему усмотрению.

Для других форматов doclet проверьте doclet.com.