Фрагмент Javascript для преобразования комментария в стиле doxygen в HTML

В отношении этого вопроса мне было интересно, если кто-нибудь знает фрагмент/библиотеку кода javascript для преобразования одного комментария doxygen в HTML?

Например,

/** This is a comment block
 *
 * \b bold text
 * \i italic text
 */

будет преобразовано во что-то вроде:

<p>This is a comment block</p>
<p><b>bold</b> text</p>
<p><i>italic</i> text</p>

Аналогично для всех других тегов doxygen, связанных с форматированием.

Я уже нашел это, и это хорошая отправная точка, если я должен реализовать это сам, но, возможно, мне не хватает полного проекта :-)

Итак, предложения приветствуются!


person Tobi    schedule 07.06.2009    source источник


Ответы (1)


Лучше всего использовать существующий инструмент/кодовую базу, которая делает хотя бы частично то, что вам нужно. Синтаксический анализ — непростая проблема, особенно поиск комментариев doxygen в коде, особенно если вы работаете с несколькими языками. Быстрый поиск не выявил каких-либо ужасно очевидных проектов, но если вы хотите создать свой собственный, если потребуется, я бы посоветовал начать с самой кодовой базы doxygen. Он с открытым исходным кодом и доступен через SVN или прямая загрузка. Имейте в виду, что doxygen написан на C++, но если вы можете следить за действиями синтаксического анализатора (возможно, только для определенного языка), это может сэкономить вам массу работы и предотвратить пропуск угловых случаев и т. д. Все зависит от того, насколько надежным вы хотите, чтобы ваш решение, и будете ли вы использовать его только вы, или вы можете в конечном итоге поддерживать его для других. Удачи!

person Quinn Taylor    schedule 14.06.2009
comment
doxygen теперь находится в git (см. doxygen.nl/download.html#gitrepos) - person albert; 24.12.2018