хороший пример Javadoc [закрывается]
Каждый раз, когда метод переопределяет другой метод, или метод реализует подпись в интерфейсе.
@Override аннотация уверяет Вас, что Вы действительно на самом деле переопределяли что-то. Без аннотации Вы рискуете орфографической ошибкой или различием в типах параметра и числе.
9 ответов
Как насчет исходного кода JDK, но доступ к нему осуществляется через стороннюю организацию, например docjar? Например, Источник коллекций .
Таким образом, большой загрузки не будет.
Страница Как писать документы для инструмента Javadoc содержит большое количество хороших примеров. Один раздел называется Примеры комментариев к документам и содержит довольно много примеров использования.
Кроме того, Javadoc FAQ содержит еще несколько примеров для иллюстрации ответов.
Я использую небольшой набор шаблонов документации:
- всегда документирует безопасность потоков
- всегда документирует неизменяемость
- javadoc с примерами (например, Formatter )
- @Deprecation на ПОЧЕМУ и КАК заменить аннотированный элемент
Взгляните на исходный код Spring framework, там отличные javadocs
Например, ANT - исходный код доступен для просмотра в Интернете: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ ant / DefaultLogger.java? view = co
Чтобы выбрать другие файлы, начните с: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ ant /? pathrev = 761528
Если вы устанавливаете JDK и также выбираете установку исходных кодов, src.zip содержит исходный код ВСЕХ общедоступных классов Java. У большинства из них довольно хорошая javadoc.
Загрузите исходные коды Lucene и посмотрите, как они это делают. У них хорошие JavaDocs.
Если все, что вам нужно, это синтаксис, то это может помочь: