Всплывающие подсказки о членах классов и структур в MS VC

Автор: JMan

Наверное, многие замечали, что в VC при нажатии “.” или “->” после имени переменной, представляющей из себя класс или структуру (дальше просто класса), мы получаем список всех членов этого класса. И хотелось бы, путешествуя по этому списку, иметь возможность увидеть краткие подсказки по тому или иному члену класса. Так вот такая возможность имеется и реализуется очень просто. Если вам нужна подсказка, состоящая всего из одной строки, то после объявления члена (в той же строке) поставьте символ строчного комментария “//” и пишите нужный текст. А если вам нужна подсказка, состоящая из двух и более строк, то в строках до объявления члена можете использовать или символы зонального комментария “/*” “*/” или  известные символы “//” для каждой строки комментария. И тогда редактор будет использовать текст из комментария, для выведения информации о члене класса. Да чуть не забыл, редактор ищет сначала комментарий в той строке, где объявлен член, и лишь после перед объявлением, поэтому приоритет имеет комментарий в той же строке, где объявлен член. Для  большей наглядности рассмотрим пример класса с описание своих членов:

class CMyTestKlass
{
protected:
  void *Buff;//внутренний буфер, где хранятся данные
  //Эта строчка, не будет использована в подсказке
  int BuffPos;//Текущая позиция, от куда будет происходить чтение
  //Размер внутреннего буфера Buff
  //если =0, то под буфер не выделено памяти
  int SizeOfBuff;
public:
  /* * возвращает данные из внутреннего массива
  ПАРАМЕТРЫ
  - DataBuff = указатель на буфер, куда будет возвращен результат считывания
  - Count = количество байт, нужное для считывания
  ВОЗВРАЩАЕТ
  >0 количество прочитанных данных
  =0 буфер уже весь прочитан
  <0 ошибка доступа (см. коды в описании кода функции)
  */
  int ReturnData(void *DataBuff,int Count);
  // * установить новую точку начала считывания данных
  //ПАРАМЕТРЫ
  //- NewPos = Новая позиция считывания
  //ВОЗВРАЩАЕТ
  //>=0 значения установлено
  //<0 ошибка, выход за границы буфера
  int SetReadPos(int NewPos);
  int GetReadPos();// Возвращает значение курсора чтения из буфера
};

И тогда, когда мы будем использовать переменные данного класса, то после “.” или “->” мы увидим список, и немного задержавшись на одном из его членов, то увидим нашу подсказку. Это показано на рисунке.