Наиболее совместимые комментарии C ++ Doxygen для IDE

Question

Я работал над кодом C ++, который будут использовать некоторые другие разработчики, с которыми я работаю. Многие разработчики здесь основаны на MS (они используют Visual Studio в качестве своей основной IDE), у нас также есть много разработчиков, которые также используют другие IDE для различных проектов (таких как Eclipse и Qt, даже некоторые разработки на C ++ Mac с XCode).

Код, который я имею, представляет собой универсальные библиотечные функции, совместимые между платформами, поэтому он будет использоваться разными разработчиками на разных платформах / IDE. Это подводит меня к моему вопросу: существует ли совместимый «стиль» комментариев Doxygen, который можно «понять» и использовать с возможностью завершения кода большинством популярных IDE (VS, Eclipse, Qt, Netbeans, XCode)? Что-то наподобие IntelliSence VS, где, когда вы используете результаты своей области видимости, всплывает описание для этого элемента.

Если не существует «совместимого» способа, существуют ли какие-либо плагины, которые можно использовать для всех IDE, которые бы позволили эту возможность, или мне пришлось бы написать свой собственный? Googling привел меня ко многим тупикам (возможно, потому, что я не могу ввести свой вопрос в правильные условия поиска), и написание собственных плагинов - вариант, хотя я бы предпочел «совместимый» стиль или существующий плагин, если это возможно, чтобы сохранить время.

Заранее спасибо!

Редактировать 1: Я должен упомянуть, что я запрашиваю комментирование в стиле Doxygen, потому что это инструмент документирования, который мы используем для создания части нашей документации, поэтому все комментарии в любом коде, который мы делаем, должны быть в стиле Doxygen (не знаю, почему эта проблема никогда не возникает до этого дошел, хаха)

Answer 1

Так что я уже давно борюсь с этим вопросом.В прошлом я использовал несколько различных программных пакетов для разработки, каждый из которых имел свои особенности в отношении использования документации для реализации некоторых из более причудливых функций.После работы над проектом в C # (и Visual Studio 2010) я пришел к выводу, что комментирование XML, кажется, работает лучше всего для меня.

Лично я считаю, что это сбой в большинстве приложений IDEСами, например, кажется, что Visual Studio действительно поддерживает комментирование XML только для приложений C #, чтобы предоставлять такие функции, как Intellisense, и менее изящную подсветку синтаксиса.Я обнаружил, что есть коммерческий плагин , доступный для «включения» этой функции в Visual Studio, но почему я должен платить за то, что просто не было включено?

Но я разошелсяиз вашего оригинального вопроса.Когда я впервые исследовал это, казалось, что Apple сама должна использовать Doxygen, поскольку они, похоже, используют этот стандарт для подсветки кода .С учетом вышесказанного, вот некоторые другие ресурсы для получения той же функциональности в других приложениях:

• Документация по Atomineer Pro представляется инструментом для работы в отношении Visual Studio хотя я лично этим не пользовался.Кажется, его относительно просто использовать.
• Eclox , кажется, интерфейсный плагин для Eclipse , который фактически использует Doxygen.Но из того, что я помню, вы должны иметь возможность настроить саму IDE в настройках C ++ для подсветки синтаксиса.
• Doxymacs поддерживает таблицу символов внутри Emacs для некоторых возможностей быстрого поиска.
• Кажется, что на странице проекта Vim есть скрипт, который обрабатывает это и для этого редактора, он называется DoxygenToolkit .

Я абсолютно чувствую твою боль.Есть что-то теплое и сложное в том, что ночные crontab генерируют четко задокументированную разметку, которая легко доступна для поиска.Я только недавно был в поиске лучшего механизма для достижения этой кроссплатформенности.Из того, что я понял, большинство сред разработки поддерживают своего рода расширения, и, поскольку Doxygen - это, по сути, «золотой стандарт», обычно так или иначе есть поддержка рожка для обуви, если его не существует «из коробки».

Если вам интересно, Doxygen фактически поддерживает комментарии C # XML из коробки, но, к сожалению, мне не удалось заставить его работать в Xcode, и я недостаточно хорошо разбираюсь в AppleScript, чтобы взломать его вместе.Но обязательно обновите, если вы это сделаете!