介紹
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列表。
添加復查注解(Adding Review Comments)
要給API添加注解,只要在相應的類型或其成員上右擊,在上下文菜單上點擊添加注解。注解對話框可將注解歸入缺陷數據庫,這個過程需要一個plug-in(在FDS程序員指南中會對此進行討論)。如果該plug-in不可用,那么to file和resolve defects按鈕也不可用。
比較API的版本
在上例中Diff標簽頁(在API View標簽頁邊上)是不可用的。要查看程序集不同版本的差異,選擇一個Assembly Group(Assembly Explorer的第二級節點),右擊,選擇上下文菜單中的Select Assemblies to Compare,點擊“Swap Old with New”,選擇舊有程序集的新版本,點擊OK,這樣就添加了程序集的一個新版本。
在分析過程完成后,切換到Diff標簽頁。你會看到一個類似于API View的API列表,但有顏色的差異。Red表示已移除,Green表示新添加,Grey表示繼承的。需要注意的是復查注解也可以添加到Diff視圖中,就像在API View中那樣。
注意:FDS的安裝目錄下包含了一個命令行工具(fxdiff.exe),它可以生成程序集組的API差異。
導出至Word文檔
要將當前的活動視圖導出至Word文檔,點擊工具欄的Word圖標或者使用Tools->Export to Document菜單項。這時會出現一個對話框,提示輸入輸出的文件名。要注意導出的文檔將復查注解保存為Word中的注解。
您可以在此處下載FDS和它的快速入門文檔。
信息來源:
Framework Design Studio Published。
Framework Design Studio Released。
Framework Design Studio Home。
本文轉自一個程序員的自省博客園博客,原文鏈接:http://www.cnblogs.com/anderslly/archive/2008/04/05/framework-design-studio-published.html,如需轉載請自行聯系原作者。