Раньше я писал простые комментарии в свои заголовочные файлы в стиле
// Returns a new string in which all occurrences of a specified string in the
// current instance are replaced with another specified string.
// - strSubject: The string to perform the replacement on.
// - strOldValue: The string to be replaced.
// - strNewValue: The string to replace all occurrences of strOldValue.
static RUNTIME_API String::type Replace
(_In_ String::type strSubject,
_In_ const String::type& strOldValue,
_In_ const String::type& strNewValue);
так что Visual Assist отображает мне именно этот комментарий:
В настоящее время я думаю об использовании Doxygen для создания документации для проекта, однако я изо всех сил пытаюсь найти стиль документации, который правильно отображается во всплывающих подсказках и может быть проанализирован с помощью Doxygen. Сначала я подумал о включении комментариев в стиле Doxygen в файлы *.cpp, чтобы отображались только комментарии заголовков. Поэтому в моем исходном файле у меня есть комментарий вроде
/*!
* Returns a new string in which all occurrences of a specified string in the
* current instance are replaced with another specified string.
*
* \param strSubject The string to perform the replacement on.
* \param strOldValue The string to be replaced.
* \param strNewValue The string to replace all occurrences of strOldValue.
*
* \return A string that is equivalent to the current string except that all
* instances of strOldValue are replaced with strNewValue. If
* strOldValue is not found in the current instance, the method returns
* the current instance unchanged.
*/
String::type String::Replace
(_In_ String::type strSubject,
_In_ const String::type& strOldValue,
_In_ const String::type& strNewValue) { /* ... */ }
Удивительно, но я получаю два разных вывода при наведении курсора на эту функцию или при получении визуальных помощников «IntelliSense». Наведение курсора на Replace дает
в то время как упомянутый IntelliSense дает
однако перемещение комментария в стиле Doxygen в заголовок приводит к странному результату
Я хотел бы знать, есть ли у вас предложения, как я могу использовать комментарии doxygen в стиле Qt, но чтобы IntelliSense отображала соответствующую всплывающую подсказку (какой бы она ни была), а не отображала разные в зависимости от того, как я ее вызываю? < em>Должен быть способ унифицировать это. (В качестве альтернативы я должен работать как всегда и создавать отдельные заголовки документов, которые состоят только из комментариев doxygen — таким образом у меня не будет проблем, но будут избыточные данные)
