代码改变世界

Framework Design Studio 发布了

2008-04-05 15:54 Anders Cui 阅读(...) 评论(...) 编辑 收藏

介绍

Krzysztof Cwalina 和他的伙计们最近在开发一个工具,可以帮助框架设计者更容易地进行设计、复查和维护高度易用的API,你可一定要看看Framework Design Studio(FDS)

可以在此处下载FDS和它的快速入门文档。

目前这个工具主要用于:

  • 列出一个托管程序集暴露的API
  • 比较一个程序集的两个版本的差异
  • 对API进行复查,对API的设计进行注解,将复查的bug整理为文档,归入缺陷数据库(通过一个可配置的plug-in)
  • 将API复查结果导出为Word文档

下面的几节描述了这些场景。

使用Framework Design Studio

运行该程序后,你要做的第一件事就是向项目中添加一个程序集,可选择菜单 Project->Add Assembly,或者点击相应的工具栏按钮。这时会出现一个对话框提示你选择一个托管程序集或托管可执行文件。添加了程序集后,左边的Assembly Explorer树会加载该程序集的结构层次、命名空间、类型。选择不同的节点会在API View显示不同的API列表。

using-framework-design-studio

添加复查注解(Adding Review Comments)

要给API添加注解,只要在相应的类型或其成员上右击,在上下文菜单上点击添加注解。注解对话框可将注解归入缺陷数据库,这个过程需要一个plug-in(在FDS程序员指南中会对此进行讨论)。如果该plug-in不可用,那么to file和resolve defects按钮也不可用。

adding-review-comments

比较API的版本

在上例中Diff标签页(在API View标签页边上)是不可用的。要查看程序集不同版本的差异,选择一个Assembly Group(Assembly Explorer的第二级节点),右击,选择上下文菜单中的Select Assemblies to Compare,点击“Swap Old with New”,选择旧有程序集的新版本,点击OK,这样就添加了程序集的一个新版本。

comparing-api-versions

在分析过程完成后,切换到Diff标签页。你会看到一个类似于API View的API列表,但有颜色的差异。Red表示已移除,Green表示新添加,Grey表示继承的。需要注意的是复查注解也可以添加到Diff视图中,就像在API View中那样。

comparing-api-versons-result

注意:FDS的安装目录下包含了一个命令行工具(fxdiff.exe),它可以生成程序集组的API差异。

导出至Word文档

要将当前的活动视图导出至Word文档,点击工具栏的Word图标或者使用Tools->Export to Document菜单项。这时会出现一个对话框,提示输入输出的文件名。要注意导出的文档将复查注解保存为Word中的注解。

exporting-to-word

您可以在此处下载FDS和它的快速入门文档。

信息来源:

Framework Design Studio Published

Framework Design Studio Released

Framework Design Studio Home