API 사용 보고서

API 사용 보고서에서 번들 세트 간의 참조 세트를 설명합니다. API 사용 Ant 태스크를 사용하여 보고서를 생성할 수 있습니다. 외부 도구 대화 상자에서 보고서를 구성 및 생성하기 위한 사용자 인터페이스가 제공됩니다. 새로운 사용 스캔 구성을 작성하려면 API 사용 보고서 구성 유형을 두 번 클릭하십시오.

API 사용 보고서 탭

API 사용 보고서 탭을 사용하여 분석을 구성할 수 있습니다.

다음 예제에서는 3.4 설치에서 Eclipse 번들로 모든 참조를 추출하기 위한 구성을 보여줍니다.

API 사용 보고서 탭


Option

설명

기본

분석 분석할 항목(API 기준선일 수도 있음), 대상 정의 또는 번들 디렉토리를 선택할 수 있습니다. 기존 보고서에 대해 HTML만 생성하도록 선택할 수도 있습니다. 하나의 옵션만 선택할 수 있고, 각 옵션으로 구성할 수도 있습니다. 예를 들어, API 기준선 분석을 선택한 경우 API 기준선 환경 설정 페이지로 이동하여 기존 기준선을 편집할 수 있습니다. API 기준선
분석 > API 기준선 콤보 상자에서 분석할 API 기준선을 선택할 수 있습니다. 기본 기준선 또는 비어 있음
분석 > 기준선... API 기준선 환경 설정 페이지에 액세스하여 분석할 기준선을 구성할 수 있습니다.  
분석 > 대상 정의 콤보 상자에서 분석할 대상 정의를 선택할 수 있습니다. 활성 대상 정의 또는 비어 있음
분석 > 대상 대상 플랫폼 환경 설정 페이지에 액세스하여 분석할 대상 정의를 구성할 수 있습니다.  
분석 > 디렉토리 번들을 포함하는 디렉토리에 대한 절대 경로를 입력할 수 있습니다. 비어 있음
분석 > 찾아보기... 분석할 번들의 폴더를 찾아볼 수 있습니다.  
분석 > 기존 사용 스캔을 위한 HTML 보고서 생성 기존 스캔에 대한 보고서를 작성할 수 있고 분석을 다시 수행할 필요가 없습니다.  
검색 > 참조 참조를 확인할 번들의 이름(또는 일치하는 RegEx)을 지정할 수 있습니다. 다음 예제를 고려해 보십시오. org\.eclipse.*. 이 예제에서는 org.eclipse. 이름으로 시작하는 번들에 대한 모든 참조를 확인하고자 합니다. 비어 있음
검색 > API 참조 API 참조를 스캔할 수 있습니다. unchecked
검색 > 내부 참조 내부 참조를 스캔할 수 있습니다. 선택됨
검색 > 잘못된 API 사용 잘못된 API 사용법, 즉 제한된 API 멤버의 사용법을 스캔할 수 있습니다. unchecked
다음에서 검색 > 일치하는 번들 예를 들어 검색 범위에서 참조를 스캔할 번들의 이름(또는 일치하는 RegEX)을 지정할 수 있습니다. 다음 예제를 고려해 보십시오. .*. 이 예제에서 이름이 문자 시퀀스와 일치하는 모든 번들을 검색하고자 합니다. 필드를 비워 두면 동일한 효과를 달성할 수 있습니다. 비어 있음
보고 > 보고서 유형 두 개의 html 보고서 형식 중에서 선택할 수 있습니다. 참조되는 번들 보고서(작성자)를 선택하면 보고서는 검색된 번들에서 참조할 유형을 포함하는 모든 번들을 나열합니다. 번들 보고서 참조(이용자)를 선택하면 보고서는 참조를 포함하는 검색 범위의 모든 번들을 표시하도록 구성됩니다.

보고서 유형을 전환할 때 참조 및 일치하는 번들 정규식이 올바른 값을 갖는지 확인하십시오. 하나의 설정에서 .*와 같은 와일드카드 표현식을 사용할 때 다른 보고서 유형으로 전환하려면 가장 유용한 보고서를 가져오도록 기타 설정으로 이동할 와일드카드가 필요합니다.

참조되는 번들 보고서(작성자)
보고 > 보고서 출력 위치 생성된 보고서를 저장할 절대 경로를 지정할 수 있습니다. 비어 있음
보고 > 찾아보기... 보고서를 출력할 위치를 선택할 수 있습니다.  
보고 > 새 결과를 보고하기 전에 보고서 디렉토리 정리 결과를 보고하는 스캔 전에 기존 XML 보고서 위치를 지울 수 있습니다. 지정된 보고서 디렉토리가 있으면 이 옵션은 해당 디렉토리를 완전히 제거하고 모든 하위 디렉토리도 반복적으로 제거합니다. unchecked
보고 > HTML 보고서 작성 모든 XML 결과를 형식화된 HTML로 변환하고 <보고서 위치>\html에 저장합니다. unchecked
보고 > HTML 보고서 위치 정리 새 보고서를 작성하기 전에 기존 HTML 위치를 정리할 수 있습니다. 지정된 HTML 디렉토리가 있으면 이 옵션은 해당 디렉토리를 완전히 제거하고 모든 하위 디렉토리도 반복적으로 제거합니다. 위에서 언급한 HTML 보고서 작성 옵션을 선택한 경우에만 이 옵션을 사용할 수 있습니다. unchecked
보고 > 검색이 완료되면 보고서 열기 분석이 완료되면 HTML 보고서를 엽니다. 위에서 언급한 HTML 보고서 작성 옵션을 선택한 경우에만 이 옵션을 사용할 수 있습니다. unchecked
보고 > 설명 보고서에 대해 사용자가 읽을 수 있는 설명을 입력할 수 있습니다. 비어 있음

패턴 탭

패턴 탭을 사용하여 다양한 정규 표현식 패턴을 작성하여 사용 분석을 제어할 수 있습니다. 현재 지원되는 패턴 유형은 세 가지입니다.

  1. 아카이브 패턴 - 분석 중 무시해야 하는 중첩된 아카이브를 지정할 수 있습니다.
  2. 패키지 패턴 - 번들 Manifest를 업데이트하지 않고 API 또는 내부여야 하는 패키지를 지정할 수 있습니다.
  3. 보고서 변환 패턴 - 보고되는 참조를 필터링할 패키지 이름 정규 표현식을 작성할 수 있습니다. 보고된 모든 참조는 완전한 패키지 이름을 사용하여 필터링됩니다.

패턴 탭


Option

설명

기본

추가... 새 패턴을 추가할 수 있습니다. 이 단추는 패턴 마법사를 시작합니다.  
편집 현재 선택된 패턴을 편집할 수 있습니다. 한 번에 패턴 하나만 편집할 수 있습니다.  
제거 선택한 패턴을 제거할 수 있습니다. 동시에 둘 이상의 패턴을 제거할 수 있습니다.  

관련 태스크

API 기준선 비교
기준선 설정

관련 참조

API 기준선 환경 설정
API 사용 패턴 마법사