实验室的项目终于结束了V2.0版,开始等待联调的日子

最后的整理在两天的体力劳动中结束了,那就是写注释

这也是中国程序员特有的现象,写完了整个程序,再来补注释,甚至补设计文档. 前天在写设计文档的时候,我还在和师姐讨论,那个Singleton到底是属于哪个框架下? 数据层,管理层还是表现层?….虽然不像Java一样分得很清的MVC结构,但我们这个文档也要求框架分明。……

用Doxygen生成程序文档,相对来说,还是减少了文档量的,至少不用自己去编排格式。但像我这样,平时注释写得不多,而且也没有统一风格的,现在再来补……实在是……

还好,大家都没有写统一的注释,我们项目组的几个人便统一狂补两天,一人分十多个类,写文件注释,类注释,函数注释

Doxygen开始看起来很晕,但自己试过几次后,发现很简单,其基本的概念就是文件中用特定格式来描述类,Doxygen程序通过分析程序文件,寻找相应的注释,如果有,则显示出来。

关于Doxygen的使用方法,挺简单的,我打算过两天整理一下心得写出来,现在暂留此作开篇吧。


评论

评论已关闭.