가이드라인: 인터페이스
인터페이스는 시스템의 사용자 보기를 표시하고 해당 구현을 숨길 때 사용됩니다. 이 가이드라인은 인터페이스 스펙을 제어하는 규칙 세트를 제안합니다.
관계
기본 설명

인터페이스 이름 지정 맨 위 페이지

  • 시스템에서 수행하는 역할을 반영하도록 인터페이스 이름을 지정합니다.
  • 이름은 1 - 2개의 단어로 짧아야 합니다.
  • 이름에 "interface"란 단어를 포함하지 마십시오. 모델 요소 유형(예: interface)에 함축되어 있습니다.

인터페이스 설명 맨 위 페이지

  • 설명에서는 인터페이스의 책임을 설명해야 합니다.
  • 설명 길이는 여러 긴 문장에서 짧은 단락까지 허용됩니다.
  • 설명은 단순히 인터페이스 이름만 다시 표시하는 것이 아니라 시스템에서 수행하는 인터페이스 역할을 설명해야 합니다.

오퍼레이션 정의 맨 위 페이지

  • 오퍼레이션 이름은 오퍼레이션의 결과를 반영해야 합니다.
  • 오퍼레이션 이름의 설정 또는 가져오기를 포함하여 오퍼레이션 설정 또는 가져오기 정보가 중복된 경우. 설정 또는 검색 중인 모델 요소의 특성과 동일한 이름으로 오퍼레이션 이름을 지정하십시오. 따라서 이름 지정된 오퍼레이션은 매개변수 없이 특성을 검색합니다. 매개변수를 사용하여 이름 지정된 오퍼레이션은 특성을 설정합니다.

예제

name()은 오브젝트 이름을 리턴합니다. name(aString)은 오브젝트 이름을 aString으로 설정합니다.

  • 오퍼레이션 설명에서는 키 알고리즘 및 리턴하는 을 포함하여 오퍼레이션의 수행 작업을 설명해야 합니다.
  • 오퍼레이션에 전달할 정보를 표시하도록 오퍼레이션의 매개변수 이름을 지정하십시오.
  • 매개변수의 유형을 식별하십시오.

인터페이스 문서화 맨 위 페이지

인터페이스에서 정의한 동작은 오퍼레이션 세트로 지정됩니다. 다음과 같은 추가 정보를 제공해야 할 수도 있습니다.

  • 오퍼레이션 사용 방법 및 수행 순서(시퀀스 다이어그램 예제에서 설명함).
  • 인터페이스를 실현하는 모델 요소의 상태로서 외부에서 관찰 가능한 상태(상태 머신에서 설명함, 가이드라인: 상태 차트 다이어그램 참조).
  • 인터페이스를 실현하는 모델 요소의 동작을 테스트하는 테스트 계획 및 스크립트.

이 정보를 그룹화 및 관리하려면 인터페이스 및 관련된 모든 중간 산출물을 포함하도록 패키지를 작성해야 합니다.

힌트 및 팁 맨 위 페이지

모든 인터페이스는 시스템에서 '연결 부분'을 표시합니다. 시스템을 '분리'하고 다시 빌드하거나 다시 디자인할 수 있는 위치를 의미합니다. 인터페이스는 디자인 또는 구현 시 스펙의 분리를 표시합니다. 다음은 올바르게 구성된 인터페이스 특징입니다.

  • 단순하면서도 완전합니다. 즉, 단일 서비스를 지정하기에 충분한, 모든 필수 오퍼레이션을 제공합니다.
  • 이해 가능합니다. 즉, 기존의 사용법 또는 구현을 점검하지 않고도 인터페이스를 사용 및 실현하는 데 필요한, 충분한 정보를 제공합니다.
  • 접근 가능합니다. 즉, 오퍼레이션의 세부사항에 압도 당하지 않고 키 특성에 대해 사용자를 안내하는 정보를 제공합니다.

인터페이스를 작성하는 경우

  • 단순히 시스템에서 연결 부분의 존재 여부를 지정해야 할 때마다 "롤리팝(lollipop)" 표기법을 사용하십시오. 대부분의 경우 클래스가 아닌 서브시스템에서 필요합니다.
  • 서비스 자체의 세부사항을 표시해야 하는 경우 확장된 "클래스" 표기법을 사용하십시오. 대부분의 경우 패키지 또는 서브시스템에서 제공하는 서비스를 지정할 때 필요합니다.