分享
 
 
 

vs.net下doxygen的设置与使用

王朝vc·作者佚名  2006-01-09
窄屏简体版  字體: |||超大  

doxygen的windows平台下的安装文件有大约5M左右,可到以下地址下载。

下载地址: http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc

下载后安装完毕即可使用命令行方式或wizard产生注释文档

---------------------------------------------------------------------------------------------------------------

vs.net的集合:(可参考codeproject文章10 Minutes to document your code)

在vs.net“工具”菜单下添加外部工具“生成文档“,参数如下:

命令: c:\program files\doxygen\bin\doxygen.exe (即doxygen的安装目录)

命令参数: $(ProjectDir)\default.doxygen

初始目录: $(ProjectDir)

选中"使用输出窗口",使doxygen的输出在vs.net 的输出窗中显示。

同时拷贝default.doxygen到工作的工程目录下($(projectdir))。

根据需要可以打开修改。

使用前面的“生成文档”工具可以给工程产生html类型的文档注释,同时产生.hhp类型的html help文档的项目文件.

同时安装HTML help workshop,可以在外部工具添加一个新项目,直接调用html help workshop的主执行文件,参数

传入生成的*.hhp文件,即可直接调用编译出chm的注释文件了。

添加外部工具,用windows目录下的 hh.exe命令可以启动浏览chm文件,这样就可以不离开vs.net开发环境来完成文档的

生成与查看了。

另外:

1.doxygen不支持vs.net中的solution概念,需要拷贝default.doxygen到具体的工程目录下。

2.vs.net中的宏定义$(projectdir)有问题,直接传给html help workshop 的参数多个引号,可手工删除。

3.我编辑的一些符合doxygen注释风格的常用宏:

Sub 函数注释()

DTE.ActiveDocument.Selection.NewLine()

DTE.ActiveDocument.Selection.Text = "//!"

DTE.ActiveDocument.Selection.NewLine()

DTE.ActiveDocument.Selection.Text = "/*!"

DTE.ActiveDocument.Selection.NewLine()

DTE.ActiveDocument.Selection.Indent()

DTE.ActiveDocument.Selection.Text = "\param"

DTE.ActiveDocument.Selection.NewLine()

DTE.ActiveDocument.Selection.Text = "\param"

DTE.ActiveDocument.Selection.NewLine()

DTE.ActiveDocument.Selection.Text = "\return"

DTE.ActiveDocument.Selection.NewLine()

DTE.ActiveDocument.Selection.Text = "\sa "

DTE.ActiveDocument.Selection.NewLine()

DTE.ActiveDocument.Selection.Text = "*/"

DTE.ActiveDocument.Selection.StartOfLine(vsStartOfLineOptions.vsStartOfLineOptionsFirstText)

DTE.ActiveDocument.Selection.DeleteLeft()

End Sub

Sub 变量注释()

DTE.ActiveDocument.Selection.NewLine()

DTE.ActiveDocument.Selection.Text = "//!"

DTE.ActiveDocument.Selection.NewLine()

DTE.ActiveDocument.Selection.StartOfLine(vsStartOfLineOptions.vsStartOfLineOptionsFirstText)

DTE.ActiveDocument.Selection.DeleteLeft()

End Sub

Sub 文件注释()

DTE.ActiveDocument.Selection.Text = "/** \file " + DTE.ActiveDocument.Name + " 版权所有 (c) 2000-2004 , 我的公司"

DTE.ActiveDocument.Selection.NewLine()

DTE.ActiveDocument.Selection.NewLine()

DTE.ActiveDocument.Selection.Indent()

DTE.ActiveDocument.Selection.Text = "\n 文件名称 : " + DTE.ActiveDocument.Name

DTE.ActiveDocument.Selection.NewLine()

DTE.ActiveDocument.Selection.Text = "\n 功能描述 : "

DTE.ActiveDocument.Selection.NewLine()

DTE.ActiveDocument.Selection.NewLine()

DTE.ActiveDocument.Selection.Text = "\author 我的大名 "

DTE.ActiveDocument.Selection.NewLine()

DTE.ActiveDocument.Selection.Text = "\n 历史信息 : 第一版 " + Date.Now

DTE.ActiveDocument.Selection.NewLine()

DTE.ActiveDocument.Selection.DeleteLeft()

DTE.ActiveDocument.Selection.Text = "*/"

DTE.ActiveDocument.Selection.NewLine()

DTE.ActiveDocument.Selection.StartOfLine(vsStartOfLineOptions.vsStartOfLineOptionsFirstText)

End Sub

Sub 变量详细注释()

DTE.ActiveDocument.Selection.NewLine()

DTE.ActiveDocument.Selection.Text = "//!"

DTE.ActiveDocument.Selection.NewLine()

DTE.ActiveDocument.Selection.Text = "/*!"

DTE.ActiveDocument.Selection.NewLine()

DTE.ActiveDocument.Selection.Indent()

DTE.ActiveDocument.Selection.Text = "*/"

DTE.ActiveDocument.Selection.StartOfLine(vsStartOfLineOptions.vsStartOfLineOptionsFirstText)

DTE.ActiveDocument.Selection.DeleteLeft()

End Sub

 
 
 
免责声明:本文为网络用户发布,其观点仅代表作者个人观点,与本站无关,本站仅提供信息存储服务。文中陈述内容未经本站证实,其真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。
2023年上半年GDP全球前十五强
 百态   2023-10-24
美众议院议长启动对拜登的弹劾调查
 百态   2023-09-13
上海、济南、武汉等多地出现不明坠落物
 探索   2023-09-06
印度或要将国名改为“巴拉特”
 百态   2023-09-06
男子为女友送行,买票不登机被捕
 百态   2023-08-20
手机地震预警功能怎么开?
 干货   2023-08-06
女子4年卖2套房花700多万做美容:不但没变美脸,面部还出现变形
 百态   2023-08-04
住户一楼被水淹 还冲来8头猪
 百态   2023-07-31
女子体内爬出大量瓜子状活虫
 百态   2023-07-25
地球连续35年收到神秘规律性信号,网友:不要回答!
 探索   2023-07-21
全球镓价格本周大涨27%
 探索   2023-07-09
钱都流向了那些不缺钱的人,苦都留给了能吃苦的人
 探索   2023-07-02
倩女手游刀客魅者强控制(强混乱强眩晕强睡眠)和对应控制抗性的关系
 百态   2020-08-20
美国5月9日最新疫情:美国确诊人数突破131万
 百态   2020-05-09
荷兰政府宣布将集体辞职
 干货   2020-04-30
倩女幽魂手游师徒任务情义春秋猜成语答案逍遥观:鹏程万里
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案神机营:射石饮羽
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案昆仑山:拔刀相助
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案天工阁:鬼斧神工
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案丝路古道:单枪匹马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:与虎谋皮
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:李代桃僵
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:指鹿为马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:小鸟依人
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:千金买邻
 干货   2019-11-12
 
推荐阅读
 
 
 
>>返回首頁<<
 
靜靜地坐在廢墟上,四周的荒凉一望無際,忽然覺得,淒涼也很美
© 2005- 王朝網路 版權所有