MS Visual Studio - как в .h написать комментарий к параметру, чтобы комментарий подсказывался в .cpp ?

@KSergey9 · Регистрация: 05.08.2022

Студворк — интернет-сервис помощи студентам

Пусть есть файлы:

a.h

C++
1
2
3
4
// Моё супер умножение
// Param1 - первый множитель
// Param2 - второй множитель
int MyFunc(int Param1, int Param2);

a.cpp

C++
1
2
3
4
5
int MyFunc(int Param1, int Param2)
{
   int res = Param1 * Param2;
   return res;
}

Если так написать комментарий в .h-файле, то когда открыт .cpp-файл и если мышкой подвести на имя функции - то во всплывающей подсказке отобразится весь комментарий к функции.

Вопрос:
А как бы так написать комментарии для параметров и где расположить в .h-файле, чтобы при наведении курсора мыши на Param1 или Param2 внутри текста функции в .cpp-файле отображался комментарий про это конкретно параметр?

Croessmah · 15.01.2025, 08:29

C++
1
2
3
4
5
6
7
/*!
Моё супер умножение
\param[in] Param1 первый множитель
\param[in] Param2 второй множитель
\return супер произведение Param1*Param2
*/
int MyFunc(int Param1, int Param2);

А если так?

@KSergey9 · 15.01.2025, 12:31 **[ТС]**

Сообщение от Croessmah

А если так?

В принципе, формат распознает. Потому что в подсказке выдаёт форматированный текст на основании такого описания (картинку приложил).
Но с переменными-параметрами всё равно не связывает, при наведении на них курсора - ничего не пишет.

Someone007 · 15.01.2025, 12:44

В VS должно работать

Code
1
2
3
4
5
6
7
8
/**
 * @brief Calculates the sum of two numbers.
 * 
 * @param a The first number.
 * @param b The second number.
 * @return The sum of a and b.
 */
int add(int a, int b);

и

Code
1
2
3
4
5
6
7
/// <summary>
/// Calculates the sum of two numbers.
/// </summary>
/// <param name="a">The first number.</param>
/// <param name="b">The second number.</param>
/// <returns>The sum of a and b.</returns>
int add(int a, int b);

@KSergey9 · 15.01.2025, 14:07 **[ТС]**

Someone007, эти варианты студия также распознаёт, да. Проверил.
Ну в том смысле, что при наведении курсора мыши на имя функции в .cpp-файле

Сообщение от KSergey9

в подсказке выдаёт форматированный текст на основании такого описания

.

Но при наведении курсора мыши на переменную-параметр в тексте функции пишет только, что это параметр - и всё, комментарий уже не добавляет.
Как бы этот комментарий тоже отображать - вот вопрос.

PS
"Называть параметры так, чтобы сразу было понятно по названию и не требовался комментарий!"
Да, да, понимаю...

Новые блоги и статьи Все статьи Все блоги /
модель ЗдравоСохранения 8. Подготовка к разному выполнению заданий anaschu 08.04.2026 https:/ / github. com/ shumilovas/ med2. git main ветка * содержимое блока дэлэй из старой модели теперь внутри зайца новой модели 8ATzM_2aurI	Блокировка документа от изменений, если он открыт у другого пользователя Maks 08.04.2026 Алгоритм из решения ниже реализован на примере нетипового документа, разработанного в конфигурации КА2. Задача: запретить редактирование документа, если он открыт у другого пользователя. / / . . .	Система безопасности+живучести для сервера-слоя интернета (сети). Двойная привязка. Hrethgir 08.04.2026 Далее были размышления о системе безопасности. Сообщения с наклонным текстом - мои. А как нам будет можно проверить, что ссылка наша, а не подделана хулиганами, которая выбросит на другую ветку и. . .	Модель ЗдрввоСохранения 7: больше работников, больше ресурсов. anaschu 08.04.2026 работников и заданий может быть сколько угодно, но настроено всё так, что используется пока что только 20% kYBz3eJf3jQ
Дальние перспективы сервера - слоя сети с космологическим дизайном интефейса карты и логики. Hrethgir 07.04.2026 Дальнейшее ближайшее планирование вывело к размышлениям над дальними перспективами. И вот тут может быть даже будут нужны оценки специалистов, так как в дальних перспективах всё может очень сильно. . .	Горе от ума kumehtar 07.04.2026 Эта мне ментальная установка, что вот прямо сейчас, мол, мне для полного счастья не хватает (нужное вписать), и когда я этого достигну - тогда и полный кайф. Одна из самых сильных ловушек на пути. . . .	Использование значений реквизитов справочника в документе, с определенными условиями и правами Maks 07.04.2026 1. Контроль срока действия договора Алгоритм из решения ниже реализован на примере нетипового документа "ЗаявкаНаРаботу", разработанного в конфигурации КА2. Задача: уведомлять пользователя, если. . .	Доступность команды формы по условию Maks 07.04.2026 Алгоритм из решения ниже реализован на примере нетипового документа "СписаниеМатериалов", разработанного в конфигурации КА2. Задача: сделать доступной кнопку (команда формы "ЗавершитьСписание") при. . .