Framework를 설계하시거나 만드시는 분에게 아주 유용한 툴이 있어 소개를 하고자 합니다.

.NET Framework를 만든 Krzysztof Cwalina 가 직접 구현한 툴로 .NET 기반의 Framework를 만들때 아주 유용한 툴입니다.

• .NET Managed Code Assembly에 노출된 API 목록들을 보여줌
• 두가지의 Assembly Version API 간의 차이점을 비교할 수 있습니다.
• API를 재 검토하고,  설명이나 의견을 나눌수있고, 버그 정보들을 모아 DB에 저장할수 있습니다
• Review Comment를 Word 포멧으로 변환해서 배포할 수 있습니다

Framework Design Studio 사용하기 위해서.

Application이 동작할때, 프로젝트에 Assembly를 먼저 추가하셔야 됩니다.

메뉴에서 Project->Add->Assembly 또는 ToolBar에서 해당 아이콘을 선택합니다.

그럼 Assembly나 실행 파일을 선택하는 다이얼로그 박스가 짠하고 나타납니다.

Assembly를 추가하면, Assembly Explore라는 Tab에서 Treeview형태로 Assemblie들, Namespace들, 그리고 다양한 타입들을 계층구조로 보여줍니다.

그럼 Tree Node에서 적당한 개체를 선택하면 오른쪽의 API View에서 해당 Node 정보가 출력됩니다.

설계된 Framework에 검토 의견을 나눌수 있습니다.

Ralph Johnson 이나 PLOP5권에서 언급한 Framework 설계 방법에서는 최소한 3개의 Target Application을 거쳐 Framework를 리펙토링하 길 권하고 있습니다.

결국 설계한 Framework를 외부로 공개해 이러한 인터페이스는 좋고 나쁘다 라는 것을 Framework 사용자로부터 FeedBack을 받을 필요가 있습니다.

이러한 시나리오를 돕기 위해 Framework Design Studio에서는 Framework 사용자로부터 Feedback을 받을수 있는 기능을 제공합니다.

API에 의견을 추가하기 위해서는 단지 해당하는 Type이나 관련 맴버들을 선택하시기만 하면 됩니다.선택하시면 아래와 같은 다이얼로그 박스가 뜨게 되고, 박스에 의견을 적으면 Defect DB에 데이터가 쌓이게 됩니다.

단 PlugIn 을 추가 하셔야 됩니다. 🙂   좀더 자세한 내용은 Framework Design Studio 프로그래머 가이드라인을 참고하셔야 됩니다.

API간의 버젼들을 비교하는 기능

위 그림에서 Diff Tab은 Disable되어 있었습니다.  동일한 Assembly 간의 버젼을 비교하기 위해서는, Assembly Explore에이 었는 Assembly Group을 선택함으로써, 새로운 버젼을 추가할수 있습니다.

오른쪽 버튼을 눌러 선택한 다음, “Select Assemblies to Compare”라는 메뉴를 선택하신후, “Swap Old with New”를 클릭하십시오.  선택한 오래된 Assembly의 새로운 버젼을 선택한후 OK 버튼을 눌리시면 됩니다.

툴이 분석을 완전히 마친후, Diff Tab이 활성화 됩니다. 그럼 Diff Tab을 눌러보면, 색깔 (Coloring)을 통해 변경 정보를 알려줍니다.

새버젼에서 빨간색은 제거된 것을 의미하고, 녹색은 새로 추가된 것, 회색은 상속을 받은 것을 의미합니다.

그리고 API View와 동일하게 검토 기능을 제공하므로, 팀들간에 의견을 나누실 수 있습니다.

Framework Design Studio가 설치된 디렉토리에 fxdiff.exe라는 command line 명령을 통해서 API Diff같이 Assebly들의 그룹들을 비교하실 수도 있습니다.

MS Word로 변환하는 기능

활동한 의견 교환이나 내용들을 Microsoft Word 포멧으로 Export할 수 있습니다.  메뉴에서 “Tools -> Export”를 누르거나  Toolbar에서 Word Icon을 선택하시면 됩니다.

Framework Design Studio에서 적은 검토 (Review) 내용들을 Microsoft Word Comment 형태로 변환하여 아래의 그림과 같이 보여질수 있습니다.