Преобразование Doxygen в XML-комментарии
-
21-09-2019 - |
Вопрос
У нас есть проект на C #, который по историческим причинам использует комментарии в стиле Doxygen и Visual Studio в одном и том же коде.Кто-нибудь пытался систематически переводить один стандарт в другой, предпочтительно в общее подмножество XML?
Я думаю, было бы не слишком сложно написать сценарий, охватывающий наиболее распространенные функции, но я бы не хотел изобретать велосипед.
Решение
Я знаю, что прошло много времени с тех пор, как вы спрашивали, но я столкнулся с той же проблемой.Вот мой 10-минутный проект с открытым исходным кодом, который должен сделать преобразование немного менее безболезненным.:-) Расширения приветствуются!
Другие советы
Первоначальный ответ на этот вопрос также включал только ссылку, поэтому я делаю то же самое:
Во-первых, ссылка выше старая, вот более новая версия ссылки: Ссылка,
Кроме того, я добавил совершенно новый вариант решения AWK script: Ссылка
Поскольку оригинальный скрипт на python у меня не работал, потому что в моем случае у нас была нотация "\brief" вместо "@brief", поэтому я написал свой собственный.(Я пока не говорю на python)
Одной из важных ключевых функций является то, что вы можете легко добавить перевод тегов или пропустить некоторые из них:
translate["\\fn"] = "skip";
translate["\\def"] = "skip";
translate["\\class"] = "skip";
translate["\\enum"] = "skip";
translate["\\struct"] = "skip";
translate["\\author"] = "skip";
translate["\\brief"] = "summary";
translate["\\param"] = "param";
translate["\\return"] = "returns";
Позже я также нашел новую версию оригинального скрипта python, так что, надеюсь, никому не придется снова запускать его с нуля!
Если бы я нашел “просто ссылку” на новый скрипт раньше, это могло бы защитить меня от некоторой головной боли.