STM32F4 库函数 注释风格

16777216

STM32 库函数中的注释风格是符合什么的，如下
[mw_shl_code=c,true]/** \brief  System Tick Configuration

    The function initializes the System Timer and its interrupt, and starts the System Tick Timer.
    Counter is in free running mode to generate periodic interrupts.

    \param [in]  ticks  Number of ticks between two interrupts.

    \return          0  Function succeeded.
    \return          1  Function failed.

    \note     When the variable <b>__Vendor_SysTickConfig</b> is set to 1, then the
    function <b>SysTick_Config</b> is not included. In this case, the file <b><i>device</i>.h</b>
    must contain a vendor-specific implementation of this function.

*/[/mw_shl_code]

这里的 /**
          ---------
          */
        \breif
       好像是符合javadoc 的一种规范，可以自动生成一种说明文件，本来以为可以使用doxygen自动导入，但是失败了。。。。。他们的chm文件我估计是这个自动导出的，有谁知道这个么，想学学。

正点原子

这。。。你参考着写就是了。

16777216

正点原子 发表于 2017-5-18 22:43
这。。。你参考着写就是了。

不是，这种风格应该可以通过自动化的软件生成help文件的