如何利用XDE生成项目说明文档

如何利用XDE生成项目说明文档

我们已经学习和掌握了如何在项目中使用Rational XDE for .NET来表达项目意图、辅助项目设计,下面我们即将学习如何利用XDEPublish功能来生成项目说明文档。

XDE包含的所有设计结构、图例以及注释信息都保存在mdx文件中,不幸的是mdx文件与项目文件紧密关联,并且必须.NET开发环境支持我们才可以浏览mdx文件内容,因此把mdx文件作为项目说明文档发布是不合理的。幸运的是,Rational XDE为我们提供了一种简单的、基于通用Html文件格式的发布方式(ROSE同样包含类似功能),操作步骤如下:

1、  分别给每个物件添加描述信息,添加方法有两种:在源码编辑器中使用<summary></summary>做注释,或者在XDEModel Documentation窗口中添加注释。

图1

2、  创建各种项目图例:

3、  Model Explore中选中需要发布的Model项,例如“TestXDE”,然后选择“工具”-“Publish Model”菜单,弹出如图对话框:

4、  指定root后点击“Publish”按钮,如下图。如果无法看到进度条,可能是XDE安装不正确,请重新安装。

5、  执行结束后XDE会为我们打开生成的说明文档,如下图。可以看到左侧的树形图与我们在XDEModel Explore中的树形图完全匹配。

6、  利用左侧的树形图进行浏览。很显然,这个图形中已经几乎包含了所有我们希望发布的信息,如设计结构、注释、图例等:

何淑文

2005-3-22

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值