Visual studio 2013 документация комментариев

Есть ли в Visual Studio что-то вроде типичной IDE java, чтобы облегчить запись комментариев c++?Visual studio 2013 документация комментариев

Например, в моем Java IDE, когда я ставлю курсор перед моей функции/метода и введите /** с последующим Enter, среда автоматически генерирует комментарий шаблона. Шаблон комментария содержит аргументы функции/method. Затем я вручную заполняю документацию для каждого аргумента.

Для дальнейшего уточнения, пожалуйста, рассмотрите эту функцию:

function int foo (int id);

Процедура:

Поместите курсор на строку непосредственно перед этой функции.
Поступил в /** и нажал Введите или что-нибудь в этом духе. (Это работает в любом редакторе Java я знаю.)

Результат:

/** 
* @param id 
* @return 
*/

источник

2015-01-29 user1097772

Выделите блок текста и использовать CTRL + K и CTRL + C комментировать вокруг них. Используйте CTRL +K и CTRL +U раскомментировать. Вы также можете попробовать расширение визуальной студии GhostDoc.

источник

2015-01-29 01:36:34 QualityPixels

Вы не получили мой вопрос. См. Раздел «Редактирование заметок». Я не хочу комментировать блок кода. Я хочу «сгенерировать» комментарий для функции/класса/etc, который будет включать '@params, @return (и т. Д., Но, вероятно, все, что мне нужно)' – user1097772

Я не уверен, это возможно в VS изначально, но есть плагины, которые это делают. Я использую [Visual Assist] (http://www.wholetomato.com/) прямо сейчас, что позволяет вам делать в значительной степени то, что это немного сложно запустить и запустить. – QualityPixels

Тройной удар. Поместите курсор над функцией и введите ///.

Компонент комментариев, содержащий параметры, генерируется в XML и может быть очищен для компиляции документации.

источник

2015-01-29 01:42:47

Я не хочу комментировать xml, просто нормальный, как '/ ** Это моя функция foo @params id * /' – user1097772

Вы уверены? Оптимальная вещь о комментариях /// заключается в том, что они доступны Intellisense. Это означает, что вы получаете комментарии, появляющиеся при запуске ввода функции, класса, интерфейса, что у вас есть. Это пригодится, когда устраняется неоднозначность кучи домашних функций. Кроме того, обратитесь к следующей статье для автоматической документации. https://msdn.microsoft.com/en-us/magazine/cc302121.aspx –

Я слышал это, но вам нужно что-то внедрить в Visual Studio, чтобы он работал, он не работает изначально. (Но что мне нужно от Microsoft ...) – user1097772

Как насчет расширения DoxygenComments?

Редактировать: только что увидел, что он выделяет только комментарии и не создает их. Atomineer Pro делает это, но это не бесплатно.

источник

2015-01-29 04:38:40

Visual studio 2013 документация комментариев

ответ

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