Java: Как я могу создавать классные документы с помощью Javadoc? - PullRequest
3 голосов
/ 28 марта 2010

Я хотел бы создать HTML-документацию для библиотеки классов Java, которая включает

  • информация руководства по программированию - не просто справка по классу
  • примеры кода в справочном документе
  • складные регионы

Я хочу, чтобы он выглядел хорошо оформленным. Примерно так:

альтернативный текст http://i40.tinypic.com/25qqjbq.jpg

Я думаю , что Javadoc предоставляет API доклетов, который позволяет другим сторонам обеспечивать генерацию документов, интегрированных в Javadoc. Есть ли вариант doclet, который я могу использовать (бесплатно), который делает что-то более приятное, чем стандартный вывод javadoc?

Я пытался погуглить, но безуспешно. Предложения?

Добавление
Я нашел doclet.com , но я не знаю, как оценить варианты. Рекомендации?

В частности, XHtmlDoclet звучит так, как будто хочет решить эти проблемы. Кто-нибудь использовал это? Я не могу заставить его работать . Также пример , предложенный XHTML Doclet, не выглядит лучше, чем документы, сгенерированные из javadoc c.1998 .


Связанный:
Почему Javadoc генерирует несовместимый XHTML?

Ответы [ 2 ]

1 голос
/ 28 марта 2010

Этот вопрос заставил меня задуматься (хорошо, Googling), и я наткнулся на этот набор тегов . Никогда не пробовал, но выглядит многообещающе.

1 голос
/ 28 марта 2010

Возможно, вы думаете об API Java doclet:

http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html

Похоже, вы добавляете примеры и текст. Я думаю, что это вполне возможно с существующими Javadocs. Проблема будет в содержании, а не в рендеринге.

Castor использовал doclet для облегчения бремени конфигурации. То же самое сделали EJB 1.0 . Посмотрите на них, если хотите.

...