在我的文档主页中,用markdown编写,我想举一些例子来说明如何在项目中注释代码。
基本上我希望我的HTML文件上的输出与SO上的输出相同,即代码示例视图中的一些原始注释代码:
/** @brief Brief description of what the function does
*
* @details This section describes in more details the purpose
* of the function and its role into the module.
*
* @param [in] bar the number to deal with
* @retval the result of some operation
*/
uint8_t foo(uint8_t bar) {
}
为了达到这个目的,我基本上将代码放在我的markdown文件中,每行左边有4个空格。
问题是Doxygen似乎像在标准源文件中一样处理这些行,我最终得到了这个:
有没有办法告诉Doxygen将这些行视为纯文本,但仍然将它们放在代码视图中?我能够使用编号的代码视图(\ code和\ endcode)来做到这一点,但我不喜欢这个解决方案,因为由于在选择中采用行号,因此复制粘贴此视图的内容更加困难。
我的文件的确切内容位于pastebin:markdown.md
但没有行号功能。