Форум разработчиков электроники ELECTRONIX.ru > Мусор в исходниках библиотек

Помощь - Поиск - Пользователи - Календарь

Полная версия этой страницы: Мусор в исходниках библиотек

Форум разработчиков электроники ELECTRONIX.ru > Сайт и форум > В помощь начинающему > ARM, 32bit

Леонид Иванович

Feb 3 2014, 10:37

Для чего в файлах исходников библиотек текст программы перемежается с мусором типа этого (файл CMSIS system_stm32f4xx.h)?

Код

/**
  * @}
  */

/** @addtogroup STM32F4xx_System_Exported_Constants
  * @{
  */

/**
  * @}
  */

/** @addtogroup STM32F4xx_System_Exported_Macros
  * @{
  */

/**
  * @}
  */

/** @addtogroup STM32F4xx_System_Exported_Functions
  * @{
  */

ViKo

Feb 3 2014, 10:47

doxygen

Леонид Иванович

Feb 3 2014, 10:58

Понятно, спасибо. Мешает читабельности.

ViKo

Feb 3 2014, 11:05

Цитата(Леонид Иванович @ Feb 3 2014, 13:58)

Понятно, спасибо. Мешает читабельности.

Я пользуюсь неким минимальным набором, каждую функцию предваряю следующего вида текстом.

Код

/*!***************************************************************************
@brief        Number to Time
@details    Преобразовать число во время
@param        Num - число
@param        *pBuf - указатель на буфер результата (9 символов + \0)
@note
*/

Мне нравится. В Notepad++ такие комментарии можно выделять своим стилем. В Keil тоже.
Сам doxygen запускаю редко. В конце работы с проектом. В-основном, чтобы убедиться, что все документировано, хотя бы минимально.
И файлы я предваряю подобными комментариями.

Леонид Иванович

Feb 3 2014, 11:57

В IAR, вроде, нет возможности выделить отдельным стилем.

Для просмотра полной версии этой страницы, пожалуйста, пройдите по ссылке.