2012-06-05 4 views
1

Я работал в проекте на C++, который использует doxygen для генерации вывода документации. Метод документации мы используем выглядит следующим образом:Поддерживает ли javadoc другие стили комментариев?

//! This is an awesome method. You should totally use this method for all sorts 
//! of cool stuff that you might want to do. 
//! @returns something useful 
string my_awesome_method() {...} 

Как вы можете видеть, мы используем //! комментарий префикс, чтобы указать Doxygen блок комментариев. Мы обнаружили, что это очень хорошо подходит для наших нужд.

Теперь мы добавляем компонент Java и хотим поддерживать согласованность с стилем комментария, который мы использовали в C++, вместо того, чтобы двигаться к тому, что мы считаем неудобным, /** */ стиль, используемый javadocs. Есть ли способ заставить javadocs распознавать другие префиксы, такие как doxygen? Или javadocs требует использования /** */? Мы могли бы просто использовать doxygen, но есть всевозможные тонкости, которые построены вокруг javadocs, так что мы хотели бы поддерживать интерфейс с этой экосистемой.

Возможно ли это? Боюсь, что ответ, вероятно, нет. :(

ответ

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