1. дома
  2. Вопрос и ответ
  3. Как упаковать документы на Java?

Как упаковать документы на Java?

2009-03-08 2 views

ответ

214

В 1.5 вы можете определить package-info.java файл и обеспечивают стандартный Javadoc стиль комментарий для пакета:

ком/Foo/package-info.java:

/** 
* com.foo is a group of bar utils for operating on foo things. 
*/ 
package com.foo; 

//rest of the file is empty

Language specification for packages

источник

2009-03-08 22:42:24

+2

Прямая ссылка на спецификацию: http://docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1 – gavenkoa

+2

в intellij вы можете щелкнуть правой кнопкой мыши по пакету и опции создать это должно быть в новом меню файла – bsautner

3

С файлом package.html на уровне пакета (т. Е. В каталоге для этого пакета). Это должен быть полностью сформированный файл HTML с указанным в нем тегом <html>.

источник

2009-03-08 22:18:50

+1

Больше тру ILS? Как должен выглядеть файл? – jjnguy

+0

Это HTML-файл, содержащий описание вашего пакета. Это оно! –

+3

Это старый способ сделать это. Начиная с Java 1.5, вы можете использовать package-info.java – k2col

38

До версии Java 1.4 вам необходимо было предоставить файл HTML package.html, как описано в других ответах.

С Java 1.5 вы также можете указать package-info.java, который содержит обычный комментарий Javadoc (без HTML). Последнее предпочтительнее, поскольку оно дает вам дополнительные возможности (особенно аннотации пакетов).

Детали: Sun's docs for javadoc

источник

2009-03-08 22:42:13 sleske

+2

+1 для упоминания в обоих направлениях и существенную разницу между ними. Кстати, по крайней мере IntelliJ IDEA в настоящее время имеет лучшую поддержку package.html (Ctrl-Q на имя пакета показывает пакет Javadocs). – Jonik

+1

Обновление к моему предыдущему комментарию: в настоящее время IDEA поддерживает 'package-info.java' просто отлично. – Jonik

Смежные вопросы

 Смежные вопросы