Функция отображения информации при наведении мышки в Visual Studio 08
Мне просто интересно, в каком из форматов я должен писать комментарии в функциях, чтобы они отображались при наведении курсора на функцию с помощью мыши.
что-то вроде
void myfunct(int a; char b, float c);
This function just messes with the variables with no objetive
but to show people from stackoverflow what I mean.
Inputs-> a: does nothing
b: neither this one
c: nope
Поэтому, когда я использую функции в большом проекте, мне не нужно искать, для чего была эта конкретная функция или каков был смысл этой переменной
Решение
Вы можете взглянуть на эта документация
Другие решения
если вы думаете о чем-то вроде C # или VB, которые показывают описание параметров и функции, в MSVC такого нет, но у Microsoft есть специальный формат для комментариев кода, который вы можете использовать для генерации справки:
/// <summary>
/// summary of variable, function, class or any thing else
/// </summary>
/// <remarks>
/// detailed description of object
/// </remarks>
/// <param name="a">description of a</param>
/// <param name="b">description of b</param>
/// <param name="c">description of c</param>
/// <returns>describe return value of function</returns>
когда вы компилируете свой код, он сгенерирует XML-документ, который можно использовать для создания справочных документов.