doxygen学习笔记

下载doxygen:http://www.cnblogs.com/duxiuxing/p/4301015.html

学习思路

doxygen能够根据代码和注释生成文档。可想而知,doxygen对注释的书写必定是有其语法要求的。在一个开发团队中推广doxygen,最需要优先考虑的问题是如何降低doxygen化注释的书写成本。如果要求开发同学必须先额外记忆大量的复杂的语法规则,这个事情是很难在开发团队中长久地坚持下去的。所以我采取的思路是:

  • 记忆尽量少的语法规则:C++注释和doxygen注释(链接:http://www.cnblogs.com/duxiuxing/p/4302502.html)
  • 针对需要文档化的对象制定统一的注释模板(*表示常用的)
    • 接口文件的说明
  • 在实际开发中按照统一的模板来添加注释
posted @ 2015-02-26 12:30  杜修杏  阅读(533)  评论(0编辑  收藏  举报