Я пишу фрагмент кода для комментариев doxygen для C / C++ в Visual Studio 2015 (с использованием XML).
Я не могу написать что-то вроде:
/**
* \fn $selected$
* \brief $BRIEF$
*
* \param $TYPE_PARAM$ $NAME_VAR$ $BRIEF_PARAM$
* \return $TYPE_RETURN$ $VALUES$
* */
$selected$;
$end$
Я хочу, чтобы $ selected $ был записан после \fn и непосредственно перед ;. Но этот синтаксис возвращает мне следующее:
/**
* \fn
* \brief BRIEF
*
* \param TYPE_PARAM NAME_VAR BRIEF_PARAM
* \return TYPE_RETURN VALUES
* */
void foo(int param);
ни с чем не пишется после \fn.
Вы можете помочь мне понять?
@albert хорошо, спасибо! И можно ли разложить $ selected $, чтобы получить тип возвращаемого значения, тип параметра и имя переменной?
Вероятно, это было бы что-то для VS, я не использую VS.
@albert файл сниппета написан в xml
Не знаю, как это работает, я думаю, проблема VS. Я только что видел в последней строке комментария: * */, наверное, лучше / лучше просто использовать */
Что ж, не похоже, что вы можете сделать что-либо из этого с помощью фрагментов, но я просто хочу указать, что Doxygen на самом деле не хочет, чтобы типы передавались в \ param или \возвращение: эта нотация предназначена для кода со статической типизацией, где Doxygen может (надеюсь) получить эту информацию, проанализировав код. (Однако C++, как известно, сложно правильно анализировать. Все, что может это сделать, уже похоже на 90% компилятора C++.)





Для doxygen
\fnне нужен, если блок комментариев находится непосредственно перед функцией (определением).