Всплывающие окна комментариев для C ++ (Visual Studio), аналогичные Eclipse и Javadoc - PullRequest
Новая
       36

Всплывающие окна комментариев для C ++ (Visual Studio), аналогичные Eclipse и Javadoc

7 голосов
/ 06 января 2012

За годы обучения в колледже я научился программировать на Java, что я и делал в Eclipse. Мне понравилась функция в Eclipse о том, как комментарии Javadoc могли появляться в окне. В данный момент я программирую на C ++, и я действительно начинаю скучать по этой функции.

Вот почему я спрашиваю: есть ли плагин чего-то, что дает тот же результат. В настоящее время я программирую на C ++ с помощью Visual Studio Express 2010, в которой нет ничего подобного, за исключением отображения интерфейса функции в окне автоматического завершения. Я хотел бы прочитать дополнительную информацию, такую ​​как, например, чтение предварительных и постусловий, либо для кода из существующих библиотек (если они существуют), либо только для кода, который я написал сам.

Теперь я знаю о Doxygen, но это не совсем то, что я ищу. Это достаточно хороший резервный механизм, но мне очень нравится, когда он легко доступен из того же окна, в котором я пишу свой код.

Существует ли что-то подобное для Visual Studio? Или я могу начать использовать версию Eclipse для C ++ и запустить там генератор Javadoc (я на самом деле не пробовал!), Чтобы получить эти приятные всплывающие комментарии?

EDIT: Я пытался заставить комментарии в стиле XML работать, но что-то вроде: 

/// <summary>This constructor takes parameters to set the 
/// members of the Cow class.
/// <param name="ho">Hobby as string of the cow.</param>
/// <param name="wt">Weight of the cow as a double.</param>
/// </summary>
Cow(const char * nm, double wt);

все еще дает мне строку «Корова (const char * nm, double wt)» во всплывающем окне. Построенный с опцией \ doc, у меня есть сгенерированный файл .xml (в моей папке Debug).

Ответы [ 3 ]

2 голосов
/ 06 января 2012

В C # вы можете написать 

///

И он сгенерирует комментарий в стиле XML, например: 

/// <summary>
///
/// </summary>
/// <param name="parameter"> </param>
/// <returns> </returns>

Вы можете позволить Visual Studio сгенерировать файл XML, который можно обработать, чтобы получить что-то вроде javadoc. Я на 100% уверен, что он работает на C #, но кажется, что C ++ использует другой стиль. Если перейти к параметрам проекта> Параметры конфигурации> Генератор документов XML> Общие и установить для «Проверка IntelliSense» значение Да, вы можете поместить комментарии в свой файл .h: 

class Test {
    public:
        // The constructor
        Test(void);
        // The destructor
        ~Test(void);
        // The function description
        void Function();
};

Если я зайду в свой main.cpp и наберу это: 

Test * test = new Test();
test->

Как только я нажимаю '>', появляется окно со списком функций (деструктор и функция в данном случае). Если я выберу функцию, например, всплывающая подсказка с «Описание функции»: 

void Test::Function();

The function description
File: test.h

Я не уверен, есть ли какие-нибудь плагины, но я надеюсь, что помог вам здесь немного!

0 голосов
/ 03 ноября 2012

Используйте SandCastle для интеграции со встроенной справкой (F1). Это не так хорошо, как встроенная справка, как в Eclipse, но вы можете навести курсор на тип, нажать F1, и вы окажетесь там.

Для этого установите Sandcastle и Sandcastle Help File Builder. Затем в своем проекте Построителя файлов справки Sandcastle обязательно установите флажок для MSHelpViewer. Это сгенерирует документацию и скрипт, который вы сможете запустить, чтобы интегрировать вашу пользовательскую документацию в справку F1.

0 голосов
/ 01 ноября 2012

Если у вас есть CodeRush / Refactor, вы можете попробовать плагин CR_Documenter (используйте VS Extension Manager).Он предоставляет новое док-окно с такой документацией.

Я с вами - Eclipse намного лучше для просмотра документации.

...