doxygen 使用

from :

http://www.latelee.org/using-gnu-linux/97-how-to-use-doxygen-under-linux.html 

doxygen是一种从源代码生成文档的工具,支持多种语言。当然,源代码中需按一定的格式写注释,这些注释的格式也能帮助我们养成很好的注释习惯,可以尝试一下。

使用doxygen生成文档的方法很简单:

$ doxygen -g –s 
$ doxygen

只需两个简单命令就可以了。

 

  example code:

        /**

         * 本轮奖励 (暂100分制)
         * @param 现有的分数

         * @param 之前的分数
         
*/
        void Update_New_Score_Final(short cur_score_Final, short pre_score_Final = 0); 

posted @ 2012-07-17 12:00  邓维  阅读(291)  评论(0编辑  收藏  举报