Есть ли что-нибудь вроде GhostDoc для C ++

Question

Когда я разрабатываю на C #, я активно использую GhostDoc для ускорения процесса комментирования моего кода.В настоящее время я работаю над проектом на C ++ и не нашел эквивалентного инструмента.Я знаю о Doxygen, но из того, что я знаю, он используется для создания документации вне кода, а не комментариев в коде.Есть ли какие-нибудь хорошие эквивалентные инструменты?Я бы предпочел тот, который работает в VS, но я мог бы справиться с тем, который работает в любой IDE.

(Прежде чем кто-нибудь поднимет этот вопрос, я не полагаюсь исключительно на GhostDoc для создания комментариев.Я просто использую его, чтобы создать отправную точку для своих комментариев.)

Answer 1

Визуальная помощь помогает, предоставляя пользовательские скрипты, выполняемые во время набора текста (или на других устройствах).

Например, у вас может быть скрипт для подобных комментариев :

/************************************************************************/
/* My comment : $end$                                                                     */
/************************************************************************/

Это было бы предложено (через поле со списком, точно такое же, как в intellisense), когда вы начнете вводить, например, "/**".Когда вы выберете это предложение (через Enter / Space / Click - настраиваемый), он вставит скрипт туда, где находится ваш курсор, и просто заменит маркеры, которые находятся между символами '$', специальными значениями (например, текущим именем файла).Здесь маркер $end $ приведет к тому, что курсор будет находиться в этом положении при выполнении скрипта.Таким образом, вы продолжаете печатать плавно.Например, с предыдущим набором скриптов, набрав точно :

/** this is a test comment to show you one of the many features Visual Assit!

просто отдаст :

/************************************************************************/
/* My comment : this is a test comment to show you one of the many features Visual Assit!                                                                     */
/************************************************************************/

Это действительно легко настроить, и поведение предложения (читайте :intellisense++) система настраивается.

Answer 2

Я написал надстройку, Документация Atomineer Pro, который очень похож на GhostDoc (он генерирует / обновляет комментарии к документации, чтобы сэкономить много времени и усилий при документировании), но он анализирует код непосредственно для себя и, таким образом, способен обрабатывать C, C ++, C ++ / CLI, C #, Java и Visual Basic, и не требует, чтобы окружающий код находился в состоянии компиляции, прежде чем он заработает.Он также автоматически добавит / обновит документацию для более сложных вещей, таких как исключения, генерируемые в теле метода.

Он работает под управлением Visual Studio 11, 2010, 2008 и 2005 и поддерживает документацию - форматы комментариев Xml, Doxygen, JavaDoc и Qt, а также формат / стиль блоков комментариев и используемые правила автоматического документирования, которые легко настраиваются.Он обладает рядом других удобных функций, таких как облегчение преобразования устаревших doc-комментариев в вышеуказанные форматы и перенос слов в doc-комментарии и обычные блочные комментарии.

Вышесказанное является лишь кратким изложением некоторых ключевых функций - это сравнение характеристик с другими продуктами служит более полным списком многих других доступных функций.

Answer 3

Визуальная помощь возможно, это сработает, хотя я не совсем уверен.