2010-05-06 2 views
0

Я нахожу способ написать сценарий, который я могу создать javadoc только для интерфейсов моей программы (не для публичных классов). Я попробовал встроенный инструмент Eclipse и даже инструмент JAutodoc, но пока не был успешным.Создать Javadoc только для интерфейсов?

У кого-нибудь есть идеи, пожалуйста?

Спасибо.

ответ

0

Лично я бы пошел с пользовательским сценарием муравья (если вы знакомы с ним). С помощью задачи javadoc вы можете использовать вложенный элемент «набор файлов» с динамически созданным списком интерфейсов. Или просто сценарий для копирования всех интерфейсов во временный каталог, запустить javadoc и удалить temp dir в конце. Последнее может быть реализовано даже с помощью скрипта bash.

Но если вы хотите, чтобы пользователь не видел ваши классы реализации, имеет смысл ограничить их видимость. И тогда вы можете создавать документацию только для публичных записей. Просто мысль.

+0

Я знаю, как генерировать javadoc, используя задачу Ant. Тем не менее, я не знаю, как проверить, является ли файл интерфейсом в скрипте Ant. Моя программа имеет сотни классов и интерфейсов, и сложность заключается в том, что интерфейсы не расположены в отдельной папке. Мне было бы легко, если бы интерфейсы были в отдельных папках. Вы знаете, как проверить файл как класс или интерфейс в скрипте Ant? Спасибо – ipkiss

+0

Идея состояла в том, чтобы просматривать их в цикле (ant-contrib позволяет это сделать), ища шаблон. Хотя, кажется, проще с bash-скриптом и идеей copy-interfaces-to-temp-folder. –

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