Как комментировать код C ++, чтобы комментарии были видны в IntelliSense - PullRequest
3 голосов
/ 15 февраля 2011

В C #, если я хочу прокомментировать функцию, я просто нажимаю / три раза, и над функцией появляются соответствующие теги.Все, что я пишу в этом теге, затем отображается в IntelliSense, чтобы я мог легко увидеть, что делает данная функция.

Однако в C ++ таких тегов нет, так как я могу прокомментировать код, чтобы мой комментарий был распознанIntelliSense?

Я пробовал две обратные косые черты над функцией

    //
    //here goes the comment
    //
    void* Foo(){}

, но это не сработало.

Ответы [ 3 ]

1 голос
/ 15 февраля 2011

Вы все еще можете использовать /// в Visual C ++ - хотя IDE не предоставляет шаблон XML.

0 голосов
/ 15 февраля 2011

Я вполне уверен, что система комментирования, которая позволяет вам добавлять данные в функции, на самом деле может быть частью спецификации C #.Хотя, возможно, это и курить.

Что касается получения этой функции для C ++, вам просто придется смириться с тем фактом, что MS в основном использует любой другой язык, кроме C #.Более или менее любая классная функция intelisense специально не предназначена для C ++.

Некоторые функции в некотором роде написаны с использованием XML-файлов, таких как создание кода C # из диаграмм UML.Я изучил это, и в теории вы можете сделать свою собственную версию C ++ для этих функций.Кто-то еще, возможно, уже сделал это.

Извините за такой вид отсутствия ответа, но в основном Visual Studio не поддерживает (по крайней мере, не изначально) делать что-то умное с комментариями для C ++, кроме добавленияи удалить их для нескольких строк одновременно.

0 голосов
/ 15 февраля 2011

Эта ссылка заявляет, что вы можете добавлять комментарии к документации кода и генерировать читаемые целые файлы из файла XML, созданного извне.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...