Подсказка ко всем методам и ко всем их параметрам

@Еkaterina · Регистрация: 24.02.2014

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

Уже сколько времени гуглю и всё впустую!!
Я пишу некую классовую структуру. Она достаточно быстро разрастается и держать в голове качественное содержание всех объектов и методов классов проблематично. И я бы хотела кратко дать подсказку ко всем методам и ко всем их параметрам. Вроде разобралась, как дать подсказку самому методу. Выглядит это примерно так:

C++
1
CPoint(int n);                              // Конструктор точки

Но вот с подсказками для переменных беда :\ Ничего конкретного найти не могу, а всё, что находила - не работало. У меня стоит MS VS 2013. Пожалуйста, подскажите новичку

@DrOffset · 11.03.2014, 22:09

Еkaterina, подсказка - это вот это?

// Конструктор точки

В чем проблема так же писать для переменных?

@Еkaterina · 11.03.2014, 22:22 **[ТС]**

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

В чем проблема так же писать для переменных?

Объясню. Когда после объявления функции написан комментарий так, как я сделала, то после наведения на название функции в любом другом месте программы появляется подсказка, в которой написан сам комментарий.

C++
1
2
3
4
5
CPoint::CPoint(int n)
{
    _n = n;
    _vector = new double[_n];
}

Если в этом описании функции навести мышь на любое место в заголовке, то выдается подсказка "Конструктор точки". А мне нужно, чтобы при наведении в этой строке на n (там, где он объявляется, как параметр), появлялась другая подсказка, сообщающая, например, "Размерность точки".
Я уже начинаю сомневаться, что такое вообще возможно сделать...

@DrOffset · 11.03.2014, 22:27

Еkaterina, а что за среда у вас?

@Еkaterina · 11.03.2014, 22:29 **[ТС]**

DrOffset, MicroSoft Visual Studio 2013

@saden · 11.03.2014, 22:34

???
СPoint(int n/*comment*/);

@Еkaterina · 11.03.2014, 22:44 **[ТС]**

При наведении мышью данная подсказка не появляется. Я знаю, что можно так подписать, но всё-таки я преследовала немножко иную цель

@saden · 11.03.2014, 22:45

???
CPoint(int n //comment
)

@DrOffset · 11.03.2014, 22:54

Еkaterina, у меня работает так:

C++
1
2
//this is a cat
cat felix;

@Еkaterina · 11.03.2014, 22:56 **[ТС]**

saden, Подсказки появились, но только локально. То есть именно в том месте, где после переменной есть комментарий, подсказка есть, в остальных местах её нет...

Добавлено через 1 минуту
DrOffset, мне хочется, чтобы не только в текущем фале появлялась подсказка, а во всех местах проекта, где происходит вызов конструктора.

KOPOJI · 11.03.2014, 23:04

http://msdn.microsoft.com/en-u... .120).aspx ?
Насколько я знаю, обычно используют либо комментирование в стиле PHPDocumentor/JavaDoc

Java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Locates a string in the string list. Use the find
// function to locate a string S in the string list.
// Only use this function if the string list is 
// sorted, to locate a string in a non-sorted string 
// list use IndexOf.                
// @param S        The string to be located.
// @param Index    The index of S is returned through 
//                 parameter if it was found. It is not 
//                 guaranteed that Index is not modified, 
//                 even if the string isn't found.
// @retval TRUE    if the string could be found in the 
//                 string list,
// @retval FALSE   otherwise.
// @see            IndexOf
// @see            Sort
// @see            Sorted

либо комментирование в стиле XMLDoc

XML
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
//  <remarks>
//      Use the find function to locate a string S in the string list.
//      Only use this function if the string list is sorted, to locate
//      a string in a non-sorted string list use IndexOf.
//  </remarks>
//  <seealso cref="IndexOf"/><seealso cref="Sort"/>
//  <seealso cref="Sorted"/>
//  <param name="S">The string to be located.</param>
//  <param name="Index">The index of S is returned through this
//              parameter if it was found. 
//              It is not guaranteed that Index is not modified, 
//              even if the string isn't found.</param>
//  <retval name="TRUE">if the string could be found in the
//             string list.</retval>
//  <retval name="FALSE">otherwise.</retval>
//  <summary>Locates a string in the string list.</summary>

Либо другие (их полно)
http://ccdoc.sourceforge.net/h... _guide.htm

К VS можно прикрутить любое (да и вообще, вроде, там должен быть встроенный генератор). Еще слышал про Doxygen, но опыта разработки на плюсах вообще можно сказать нет, поэтому не в курсе..

@Еkaterina · 11.03.2014, 23:56 **[ТС]**

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

@SatanaXIII · 12.03.2014, 09:33

Еkaterina, не могу сейчас что-то с ходу найти: есть в visual studio собственная плюшка - тройной слеш - комментарий, позволяющий делать описание при объявлении.

Добавлено через 14 минут
Что-то типа того - http://www.interface.ru/home.asp?artId=23760 ?

@Еkaterina · 12.03.2014, 13:37 **[ТС]**

Всё заработало как надо! Спасибо огромное!

Новые блоги и статьи Все статьи Все блоги /
SDL3 для Web (WebAssembly): Реализация движения на Box2D v3 - трение и коллизии с повёрнутыми стенами 8Observer8 20.02.2026 Содержание блога Box2D позволяет легко создать главного героя, который не проходит сквозь стены и перемещается с заданным трением о препятствия, которые можно располагать под углом, как верхнее. . .	Конвертировать закладки radiotray-ng в m3u-плейлист damix 19.02.2026 Это можно сделать скриптом для PowerShell. Использование . \СonvertRadiotrayToM3U. ps1 <path_to_bookmarks. json> Рядом с файлом bookmarks. json появится файл bookmarks. m3u с результатом. # Check if. . .	Семь CDC на одном интерфейсе: 5 U[S]ARTов, 1 CAN и 1 SSI Eddy_Em 18.02.2026 Постепенно допиливаю свою "многоинтерфейсную плату". Выглядит вот так: https:/ / www. cyberforum. ru/ blog_attachment. php?attachmentid=11617&stc=1&d=1771445347 Основана на STM32F303RBT6. На борту пять. . .	Камера Toupcam IUA500KMA Eddy_Em 12.02.2026 Т. к. у всяких "хикроботов" слишком уж мелкий пиксель, для подсмотра в ESPriF они вообще плохо годятся: уже 14 величину можно рассмотреть еле-еле лишь на экспозициях под 3 секунды (а то и больше),. . .
И ясному Солнцу zbw 12.02.2026 И ясному Солнцу, и светлой Луне. В мире покоя нет и люди не могут жить в тишине. А жить им немного лет.	«Знание-Сила» zbw 12.02.2026 «Знание-Сила» «Время-Деньги» «Деньги -Пуля»	SDL3 для Web (WebAssembly): Подключение Box2D v3, физика и отрисовка коллайдеров 8Observer8 12.02.2026 Содержание блога Box2D - это библиотека для 2D физики для анимаций и игр. С её помощью можно определять были ли коллизии между конкретными объектами и вызывать обработчики событий столкновения. . . .	SDL3 для Web (WebAssembly): Загрузка PNG с прозрачным фоном с помощью SDL_LoadPNG (без SDL3_image) 8Observer8 11.02.2026 Содержание блога Библиотека SDL3 содержит встроенные инструменты для базовой работы с изображениями - без использования библиотеки SDL3_image. Пошагово создадим проект для загрузки изображения. . .

@DrOffset 19500 / 10105 / 2461 Регистрация: 30.01.2014 Сообщений: 17,816
	11.03.2014, 22:27
	Еkaterina, а что за среда у вас? 0

@Еkaterina 0 / 0 / 0 Регистрация: 24.02.2014 Сообщений: 19
	11.03.2014, 22:29 [ТС]
	DrOffset, MicroSoft Visual Studio 2013 0

@saden 184 / 168 / 53 Регистрация: 27.01.2013 Сообщений: 788
	11.03.2014, 22:34
	??? СPoint(int n/comment/); 0

@Еkaterina 0 / 0 / 0 Регистрация: 24.02.2014 Сообщений: 19
	11.03.2014, 22:44 [ТС]
	При наведении мышью данная подсказка не появляется. Я знаю, что можно так подписать, но всё-таки я преследовала немножко иную цель 0

@saden 184 / 168 / 53 Регистрация: 27.01.2013 Сообщений: 788
	11.03.2014, 22:45
	??? CPoint(int n //comment ) 0

@Еkaterina 0 / 0 / 0 Регистрация: 24.02.2014 Сообщений: 19
	11.03.2014, 22:56 [ТС]
	saden, Подсказки появились, но только локально. То есть именно в том месте, где после переменной есть комментарий, подсказка есть, в остальных местах её нет... Добавлено через 1 минуту DrOffset, мне хочется, чтобы не только в текущем фале появлялась подсказка, а во всех местах проекта, где происходит вызов конструктора. 0

@Еkaterina 0 / 0 / 0 Регистрация: 24.02.2014 Сообщений: 19
	11.03.2014, 23:56 [ТС]
	Спасибо большое! Пробовала раньше писать, как вы предложили, но не получалось (хотя я могла и просто-напросто что-то сделать неправильно). Ссылка заинтересовала, посмотрю 0

@SatanaXIII Почетный модератор 5851 / 2862 / 392 Регистрация: 01.11.2011 Сообщений: 6,906
	12.03.2014, 09:33
	Сообщение было отмечено Еkaterina как решение Решение Еkaterina, не могу сейчас что-то с ходу найти: есть в visual studio собственная плюшка - тройной слеш - комментарий, позволяющий делать описание при объявлении. Добавлено через 14 минут Что-то типа того - http://www.interface.ru/home.asp?artId=23760 ? 2

@Еkaterina 0 / 0 / 0 Регистрация: 24.02.2014 Сообщений: 19
	12.03.2014, 13:37 [ТС]
	Всё заработало как надо! Спасибо огромное! 0

Подсказка ко всем методам и ко всем их параметрам

Решение