Interface Intention Measuring Metric for Software Maintainability and Evaluation

Abstract

소프트웨어 애플리케이션이 설계되고 구현될 때, 인터페이스가 설계자의 의도를 드러내도록 작성되는 것이 중요하다. 인터페이스에 의도가 잘 드러나도록 작성이 되어있으면 해당 애플리케이션을 사용하는 클라이언트 개발자가 사용하려는 인터페이스의 설계 의도를 파악하는데에 드는 시간과 노력을 줄일 수 있게 해준다. 하지만 문서화가 잘 되어있지 않거나 인터페이스가 의도를 드러내도록 작성되지 않은 경우 사용자가 인터페이스 사용 방법을 이해하기 위해 내부를 들여다보는 시간과 노력이 더욱 들게 된다. 게다가 코드가 실행되어서 연산이 수행되지만 연산 자체가 명확하게 표현되지 않은 경우, 코드의 수행 결과를 이해하거나 변경의 파급 효과를 예상하기가 어렵다. 본 논문에서는 소프트웨어 애플리케이션이 유지보수 되면서 인터페이스를 새로 작성하거나 변경될 때, 인터페이스가 의도를 드러내도록 작성/변경될 수 있도록, 인터페이스의 의도를 정량적 측정하여 나타내주는 인터페이스 의도 측정 메트릭을 제안한다. 메트릭의 결과 값이 높으면 의도가 잘 드러난 것을 의미하고, 낮으면 잘 드러나지 못한 것을 의미한다. 제안하는 메트릭을 통해, 사용자는 메트릭의 결과 값이 높게 측정될 수 있도록 하기 위해서 클래스 이름, 메서드 이름, 파라미터의 이름이 의도를 잘 드러내도록 작성할 것이다. 또한 제안하는 메트릭을 통해 의도를 잘 드러내게 된 인터페이스는 이를 사용하는 클라이언트 개발자의 이해도를 높이는 데에도 기여할 수 있다.; When the software applications are designed and implemented, it’s important that the interfaces are designed revealing intention of a designer. If the interface wrote revealing its intention, it helps to reduce time and efforts about comprehending the intention of the interfaces for client developers. However, if there’re no skillful documentations or the interfaces don’t reveal their intention, the users need many time and efforts to comprehend the use of the interfaces. Furthermore, if the codes and operations are executed without clear operaaion itself, it’s difficult to comprehend the result of the operation or anticipate ripple effects of changes. In this paper, as the software applications are maintained, we propose interface intention measuring metrics which measure intention of the interface quantitatively and indicate it to help for the interface to be written and be changed revealing intention when the interfaces are written and changed. The higher metrics’ result value means the interfaces reveal intention well. otherwise, the lower metrics’ result value manes the interfaces don’t reveal intention well. Through the proposing metrics, the users write or change intention revealing class names, method names and parameter names. Also, through the metrics, the intention revealing interfaces can contribute to make client developers’ understanding high.