Почему в заголовках комментариев в C или C++ есть избыточные косые черты "*//**"C++

Программы на C++. Форум разработчиков
Ответить
Anonymous
 Почему в заголовках комментариев в C или C++ есть избыточные косые черты "*//**"

Сообщение Anonymous »

Я часто вижу:

Код: Выделить всё

/**************************************************************************//**
* some comments
*****************************************************************************/
Почему бы и нет:

Код: Выделить всё

/*****************************************************************************
* some comments
*****************************************************************************/
Насколько я понимаю, для обработки doxygen требуются специальные комментарии (см.: Документирование кода). Но у него также есть возможность включить JAVADOC_BLOCK в doxyfile. Зачем жертвовать эстетикой кода, если в этом нет необходимости? Вы также можете добавить команды doxygen в эти блоки или оставить их, если хотите.
Изменить:
Я получаю неожиданное поведение при проверке JAVADOC_BLOCK, но снятии флажка JAVADOC_AUTOBRIEF. Он по-прежнему выполняет автоматическое подведение итогов.

Если для тега JAVADOC_AUTOBRIEF установлено значение YES, тогда doxygen будет интерпретировать
первую строку (до первой точки) Javadoc. комментарий в стиле краткого
описания. Если установлено значение NO, стиль Javadoc будет вести себя так же, как обычные комментарии в стиле Qt-
(таким образом, для краткого
описания требуется явная команда @brief.
)[выделено мной ]

Код: Выделить всё

/******************************************************************************
*
* \file a.c
*
******************************************************************************/

/******************************************************************************
*
* javadoc header without brief
*
******************************************************************************/
void a(void)
{
}

/******************************************************************************
*
* \brief javadoc header with brief
*
******************************************************************************/
void b(void)
{
}

/**************************************************************************//**
*
* doxystyle header without brief
*
******************************************************************************/
void c(void)
{
}

/**************************************************************************//**
*
* \brief doxystyle header with brief
*
******************************************************************************/
void d(void)
{
}

int main(void)
{
a();
b();
c();
d();
return 0;
}
В doxygen-1.11.0 a и c автобриф

Подробнее здесь: https://stackoverflow.com/questions/787 ... -in-c-or-c
Ответить

Быстрый ответ

Изменение регистра текста: 
Смайлики
:) :( :oops: :roll: :wink: :muza: :clever: :sorry: :angel: :read: *x)
Ещё смайлики…
   
К этому ответу прикреплено по крайней мере одно вложение.

Если вы не хотите добавлять вложения, оставьте поля пустыми.

Максимально разрешённый размер вложения: 15 МБ.

Вернуться в «C++»