2014-11-04 3 views
2

Я нахожу множество аннотаций @doc через модули Rascal, но не знаю, как они работают. Я попытался создать javadoc, но это не поддерживается напрямую. Я считаю, что должен быть способ генерировать коллекцию документов, запуская процесс через модули в проекте Rascal. Любые помощь оценивается ...назначение аннотаций @doc и генерация документа из модулей Rascal

ответ

1

Хороший вопрос, который не имеет хорошего ответа. Тег doc используется для создания страниц репетитора по адресу http://tutor.rascal-mpl.org, для стандартной библиотеки и используется средством проверки типов (которое будет выпущено) для создания справки наведения в среде IDE. В настоящее время у нас нет процесса для любого проекта, как вы описали. Там должен быть!

1

Необходимый информационный формат аннотаций @doc документально подтвержден в Tutor documentation. Эта информация используется для документирования, например, библиотечных функций. Чтобы создать впечатление: документация о функциях Rascal на Lists создается из исходного кода найденного модуля List here.

Такая же информационная структура используется для полных страниц Tutor. Например, файл Rascal.concept приводит к этому Main page урока Rascal.

Есть некоторые cavests:

  • В @doc тегах пока не используются последовательно во всех кодовой базе.
  • Надежная поддержка @doc информации по-прежнему отсутствует в среде IDE.