[논문 리뷰] Visualizing Object-oriented Software for Understanding and Documentation

Ra’Fat Al-Msie’deen|arXiv (Cornell University)|2016. 01. 28.

Software Engineering Research참고 문헌 36인용 수 12

한 줄 요약

이 논문은 코드 종속성, 클래스 관계, 패키지 구조 및 소프트웨어 메트릭을 상호작용 가능한 그래프에 통합하여 객체 지향 소프트웨어의 자동 시각화 방법을 제안한다. 이 방법은 구조적 및 정량적 코드 특징을 매핑함으로써 시스템을 효과적으로 문서화하며, 사례 연구를 통해 정확하고 종합적인 시스템 표현이 가능함을 확인한다.

ABSTRACT

Understanding or comprehending source code is one of the core activities of software engineering. Understanding object-oriented source code is essential and required when a programmer maintains, migrates, reuses, documents or enhances source code. The source code that is not comprehended cannot be changed. The comprehension of object-oriented source code is a difficult problem solving process. In order to document object-oriented software system there are needs to understand its source code. To do so, it is necessary to mine source code dependencies in addition to quantitative information in source code such as the number of classes. This paper proposes an automatic approach, which aims to document object-oriented software by visualizing its source code. The design of the object-oriented source code and its main characteristics are represented in the visualization. Package content, class information, relationships between classes, dependencies between methods and software metrics is displayed. The extracted views are very helpful to understand and document the object-oriented software. The novelty of this approach is the exploiting of code dependencies and quantitative information in source code to document object-oriented software efficiently by means of a set of graphs. To validate the approach, it has been applied to several case studies. The results of this evaluation showed that most of the object-oriented software systems have been documented correctly.

연구 동기 및 목표

• 유지보수, 재사용 또는 개선 과정에서 복잡한 객체 지향 소프트웨어 시스템을 이해하는 데 도전하는 데 목적을 둔다.
• 구조적 및 정량적 코드 특징을 추출하고 시각화하여 소프트웨어 문서화를 향상시키는 데 목적을 둔다.
• 저수준의 코드를 직관적인 그래픽 표현으로 변환함으로써 리버스 엔지니어링의 인지 부담을 줄이는 데 목적을 둔다.
• 의존성 인식 기반의 자동화된 시각 모델을 통해 소프트웨어 아키텍처를 효율적으로 분석하는 데 목적을 둔다.
• 실제 사례 연구를 통해 실용적 적용성을 확인하기 위해 접근법을 검증하는 데 목적을 둔다.

제안 방법

• 소스 코드를 분석하여 패키지 구조, 클래스 계층, 메서드 수준의 종속성 및 클래스 수, 결합도와 같은 소프트웨어 메트릭을 추출한다.
• 클래스, 패키지, 메서드 간의 관계를 시각화하기 위해 상호 관련된 다수의 그래프를 구축한다.
• 통합된 시스템 표현을 위해 정적 구조 정보와 정량적 메트릭을 통합한다.
• 상속, 연관, 종속성, 메서드 호출 관계를 그래프 기반 렌더링을 통해 표시한다.
• 코드 구조의 상호작용 탐색을 지원하여 탐색과 이해를 돕는다.
• 소스 코드를 처리하고 시각 문서를 생성하는 자동화된 파이프라인으로 구현된다.

실험 결과

연구 질문

• RQ1 코드 종속성과 구조적 메트릭을 효과적으로 통합하면 소프트웨어 이해가 어떻게 향상될 수 있는가?
• RQ2 자동 시각화가 객체 지향 시스템을 문서화하는 데 필요한 노력의 양을 줄일 수 있는가?
• RQ3 코드 구조의 시각적 표현이 복잡한 시스템의 이해를 어느 정도 향상시키는가?
• RQ4 제안된 방법이 실제 소프트웨어 시스템의 아키텍처를 얼마나 정확하게 재구성할 수 있는가?
• RQ5 소프트웨어 메트릭은 코드 시각화의 명확성과 유용성을 높이는 데 어떤 역할을 하는가?

주요 결과

• 시각화 방법은 종속성, 관계 및 메트릭을 통합하여 일관된 그래픽 뷰로 객체 지향 소프트웨어 시스템을 성공적으로 문서화하였다.
• 사례 연구에서 대부분의 소프트웨어 시스템이 정확하게 표현되었으며, 이는 방법의 신뢰성을 확인한다.
• 소프트웨어 메트릭의 통합은 기본적인 구조 다이어그램을 넘어서 시각화의 해석 가능성을 향상시켰다.
• 이 방법은 패키지 내용과 클래스 간 상호의존성과 같은 핵심 아키텍처 특징을 효과적으로 포착함을 입증하였다.
• 결과적으로 자동 시각화가 소프트웨어 이해 및 문서화 작업을 크게 지원하는 것으로 나타났다.
• 이 방법은 코드베이스에 대한 즉각적이고 체계적인 시각적 통찰을 제공함으로써 수동 리버스 엔지니어링의 노력을 줄였다.