Vooon писал(а):лучше писать комменты так, чтобы они были совместимы с doxygen'ом
да и комменты написанные для доксигена очень хороше читаются просто в коде
пример:
- Код: Выделить всё
/**
* This function puts a character into the USART output queue for
* transmission.
*
* \param ch character to be transmitted
* \return ch on success, -1 on error (queue full)
*/
int16_t putch(char ch);
Добавлено спустя 10 минут 35 секунд:
и вот пример сгенеренной документации
Не скажу, что с ходу разобрался как в этой документации ориентироваться
возможно не самый удачный пример и смесь русской обертки и англоязычного содержания.
Правда, я не сидел долго с целью разобраться - с налету не получилось...
