Java API интерфейс - PullRequest
       8

Java API интерфейс

9 голосов
/ 04 июля 2011

С тех пор, как я начал играть со Scala, у меня возник один большой вопрос, касающийся Java API: почему Oracle сохраняет ту же старую страницу HTML с тегами frameset и вообще без функции поиска?Похоже, что они еще не дошли до Web 2.0 ...

Документация по API Scala , с другой стороны, хотя и не самый лучший сайт в истории веб-поиска, на несколько порядковболее пригодным для использования.

В любом случае, если кто-нибудь знает, почему это так, и, что более важно, если существует документация по Java API с улучшенным интерфейсом, пожалуйста, дайте мне знать!

Ответы [ 4 ]

3 голосов
/ 04 июля 2011

В последнее время для Java 7 был улучшен JavaDoc, чтобы он мог использовать пользовательский CSS.Вот первые результаты: http://download.java.net/jdk7/docs/api/. Работа продолжается, и я думаю, что мы увидим больше, когда выйдут новые обновления.Я согласен, что ScalaDoc лучше, но им не пришлось иметь дело с 15-летним наследием.

enter image description here

enter image description here

1 голос
/ 04 июля 2011

Эти HTML-страницы были созданы с использованием инструментов Javadoc , стандартного способа создания документации на Java.

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

1 голос
/ 04 июля 2011

Javadocs предоставляет выходные данные в этом формате и публикует их по этому адресу, я думаю, что никто не видел необходимости в улучшении, но теперь, когда вы упомянули об этом, это делает интересный побочный проект. Я погуглил, чтобы найти, был ли какой-нибудь "лучший" интерфейс, но не повезло.

Вы можете запустить javadoc -h, чтобы увидеть, какие дополнительные опции доступны, если вы хотите заново сгенерировать javadocs. Некоторые интересные из них состоят в том, чтобы предоставить пользовательский колонтитул и ссылку на источник, но ничего, о чем вы просите.

0 голосов
/ 06 июля 2011

JavaDoc был разработан, чтобы быть наименьшим общим знаменателем. Его может отобразить практически любой веб-браузер, даже без поддержки JavaScript.

Если вы ищете более быстрый доступ и возможности поиска, вы можете получить доступ к JavaDoc из IDE, например Eclipse.

...