本篇文章为大家展示了如何用doxygen写程序注释,内容简明扼要并且容易理解,绝对能使你眼前一亮,通过这篇文章的详细介绍希望你能有所收获。
接触doxygen是从接触lib3ds库开始的,这个库的源代码使用doxygen作为文档的注释,很爽,直接使用工具就可以生成一个非常漂亮的文档。所以我也开始学着用doxygen作注释。
很简单,一个文件的开始写文档的头
/*! file: filename brief: This is a file ..... */
对于类
//! Class Description
对于函数
/*! Function parm parm1 description1 parm parm2 description2 */
等等,感觉很简单的东西,就可以生成很强大的文档,包括类的继承关系、函数的调用关系都很清楚~~~
上述内容就是如何用doxygen写程序注释,你们学到知识或技能了吗?如果还想学到更多技能或者丰富自己的知识储备,欢迎关注亿速云行业资讯频道。
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。