Using Doxygen with C, do you comment the function prototype or the definition? Or both?

前端 未结 5 823
余生分开走
余生分开走 2020-12-28 14:18

I\'m using Doxygen with some embedded C source. Given a .c/.h file pair, do you put Doxygen comments on the function prototype (.h file) or the function definition (.c file)

5条回答
  •  独厮守ぢ
    2020-12-28 15:11

    We comment only the function definitions, but we use it with C++.
    Write it at both places is wasting time. About the warning, if your documentation looks good, maybe it's a good way to ignore such warnings.

提交回复
热议问题