Функция отображения информации при наведении мышки в 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

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

4 голоса | спросил Ander Biguri 3 +04002012-10-03T18:55:43+04:00312012bEurope/MoscowWed, 03 Oct 2012 18:55:43 +0400 2012, 18:55:43

2 ответа


0

Вы можете посмотреть эта документация

ответил Christian Stieber 4 +04002012-10-04T03:03:51+04:00312012bEurope/MoscowThu, 04 Oct 2012 03:03:51 +0400 2012, 03:03:51
0

если вы думаете о чем-то вроде 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-документ, который можно использовать для создания справочных документов.

ответил BigBoss 3 +04002012-10-03T19:42:22+04:00312012bEurope/MoscowWed, 03 Oct 2012 19:42:22 +0400 2012, 19:42:22

Похожие вопросы

Популярные теги

security × 330linux × 316macos × 2827 × 268performance × 244command-line × 241sql-server × 235joomla-3.x × 222java × 189c++ × 186windows × 180cisco × 168bash × 158c# × 142gmail × 139arduino-uno × 139javascript × 134ssh × 133seo × 132mysql × 132