Статьи

Документация сообщества

Одной из самых сильных сторон языков с открытым исходным кодом является то, что документация изобилует комментариями, советами и фрагментами кода, внесенными пользователями. Сообщество Java само по себе довольно открыто, но платформа, в конечном счете, контролируется одним объектом — и документацией вместе с ним.

К счастью, уроки были извлечены из удивительных пользовательских ресурсов, таких как Руководство по PHP, и Java начала создавать свои собственные предложения в этой области.

Лукас Чан, один из разработчиков на SitePoint, нашел KickJava полезным. Это полный указатель методов, классов и пакетов в стандартных библиотеках платформы Java (J2SE, J2EE, J2ME, Java TV, Java Phone и Java Card), содержащий комментарии, советы и, в более общем случае, фрагменты кода. Если вы опытный разработчик, которому просто нужно увидеть класс в действии, чтобы понять, как он работает, это может быть идеальным справочником для вас.

Совсем недавно Javalobby (который также обновил свой основной сайт на прошлой неделе) запустил JDocs.com . Компиляция документов для 132 API на момент написания этой библиотеки позволяет пользователям отправлять комментарии для любого содержащегося в ней класса, и все это полностью доступно для поиска. Если вы войдете в систему, вы даже сможете настроить персонализированные списки ваших любимых классов, пакетов и API, чтобы информация, которая вам нужна, всегда была на расстоянии одного клика.

Когда JDocs.com был впервые запущен, было много статического вокруг факта, что Sun не хотела, чтобы они включали основные библиотеки Java на сайт. Sun была обеспокоена тем, что комментарии пользователей, перемежающиеся с официальной документацией, могут вводить разработчиков в заблуждение и наносить ущерб целостности платформы.

К счастью, мозги в Javalobby смогли получить Sun, добавив комментарии к этим пакетам в отдельном фрейме под официальной документацией. И с миром все в порядке.