รายงานการใช้ API

รายงานการใช้ API อธิบายถึงชุดของการอ้างถึงจากชุดของบันเดิลหนึ่งชุดกับชุดของบันเดิลอื่น รายงานสามารถสร้างขึ้นได้โดยใช้ ภารกิจ Ant สำหรับการใช้ API ส่วนติดต่อผู้ใช้จัดเตรียมไว้เพื่อกำหนดคอนฟิกและสร้างรายงานในไดอะล็อก เครื่องมือภายนอก เพื่อสร้างคอนฟิกูเรชันสแกนการใช้งานใหม่ ให้ดับเบิลคลิกที่ชนิดของคอนฟิกูเรชัน รายงานการใช้ API

แท็บรายงานการใช้ API

แท็บ รายงานการใช้ API ยอมให้คุณกำหนดคอนฟิกเพื่อการวิเคราะห์

ตัวอย่างต่อไปนี้แสดงคอนฟิกูเรชันที่ต้องแตกการอ้างถึงบันเดิล Eclipse ทั้งหมดในการติดตั้งเวอร์ชัน 3.4

แท็บรายงานการใช้ API


อ็อพชัน

คำอธิบาย

ดีฟอลต์

วิเคราะห์ คุณสามารถเลือกสิ่งที่คุณต้องการวิเคราะห์ ซึ่งสามารถเป็นได้ทั้ง API พื้นฐาน นิยามเป้าหมาย หรือไดเร็กทอรีของบันเดิล คุณยังสามารถเลือกเพื่อสร้างเฉพาะ HTML สำหรับรายงานที่มีอยู่ คุณสามารถเลือกได้เพียงหนึ่งอ็อพชัน พร้อมกับแต่ละอ็อพชันที่ยอมให้คุณกำหนดคอนฟิก เช่น คุณสามารถไปยังหน้าการกำหนดค่าตามความชอบสำหรับ API พื้นฐานเพื่อแก้ไขข้อมูลพื้นฐานที่มีอยู่หากคุณเลือกการวิเคราะห์ API พื้นฐาน API พื้นฐาน
วิเคราะห์ > API พื้นฐาน คุณสามารถเลือก API พื้นฐานใดๆ ได้จากคอมโบบ็อกซ์เพื่อทำการวิเคราะห์ ข้อมูลพื้นฐานที่เป็นค่าดีฟอลต์หรือว่าง
วิเคราะห์ > ข้อมูลพื้นฐาน... ยอมให้เข้าถึงหน้าการกำหนดค่าตามความชอบสำหรับ API พื้นฐาน เพื่อกำหนดคอนฟิกข้อมูลพื้นฐานเพื่อวิเคราะห์  
วิเคราะห์ > นิยามของเป้าหมาย คุณสามารถเลือกนิยามเป้าหมายใดๆ จากคอมโบบ็อกซ์เพื่อวิเคราะห์ นิยามของเป้าหมายที่แอ็คทีฟหรือว่าง
วิเคราะห์ > เป้าหมาย ยอมให้เข้าถึงหน้าการกำหนดค่าตามความชอบสำหรับ แพลตฟอร์มเป้าหมาย เพื่อกำหนดคอนฟิกนิยามเป้าหมายเพื่อวิเคราะห์  
วิเคราะห์ > ไดเร็กทอรี คุณสามารถป้อนพาธสัมบูรณ์ไปยังไดเร็กทอรีที่มีบันเดิล ว่างเปล่า
วิเคราะห์ > เรียกดู... ยอมให้คุณเรียกดูโฟลเดอร์ของบันเดิลเพื่อวิเคราะห์  
วิเคราะห์ > สร้างรายงาน HTML สำหรับการใช้สแกนที่มีอยู่ ยอมให้คุณสร้างรายงานสำหรับสแกนที่มีอยู่และไม่ต้องดำเนินการกับการวิเคราะห์อีกครั้ง  
ค้นหา > การอ้างถึง ยอมให้คุณระบุชื่อ (หรือจับคู่ RegEx) ของบันเดิลที่คุณต้องการดูการอ้างถึง โปรดพิจารณาตัวอย่างต่อไปนี้: org\.eclipse.* ในตัวอย่างนี้เรากำลังพูดว่า เราต้องการดูการอ้างถึงบันเดิลใดๆ ทั้งหมดที่ขึ้นต้นด้วยชื่อ org.eclipse. ว่างเปล่า
ค้นหา > การอ้างถึง API ยอมให้คุณสแกนการอ้างถึง API ยกเลิกการทำเครื่องหมาย
ค้นหา > การอ้างถึงภายใน ยอมให้คุณสแกนสำหรับการอ้างถึงภายใน ทำเครื่องหมาย
ค้นหา > การใช้ API ที่ผิดกฎเกณฑ์ ยอมให้คุณสแกนการใช้ API ที่ผิดกฎเกณฑ์ เช่น การใช้งานของสมาชิก API ที่ถูกจำกัด ยกเลิกการทำเครื่องหมาย
ค้นหาใน > การจับคู่บันเดิล ยอมให้คุณระบุชื่อ (หรือการจับคู่ RegEx) ของบันเดิลที่คุณต้องการสแกนสำหรับการอ้างถึง เช่น ขอบเขตของการค้นหา โปรดพิจารณาตัวอย่างต่อไปนี้: .* ในตัวอย่างนี้ เรากำลังพูดว่า เราต้องการค้นหาบันเดิลทั้งหมดที่มีชื่อที่ตรงกับลำดับอักขระใดๆ ผลกระทบที่เหมือนกันนี้สามารถทำให้บรรลุผลได้โดยปล่อยให้ฟิลด์ว่าง ว่างเปล่า
การรายงาน > ชนิดของรายงาน อนุญาตให้คุณเลือกระหว่างรูปแบบรายงาน html สองรูปแบบ ถ้าเลือก รายงานบันเดิลที่ถูกอ้างอิง (Producers) รายงานจะแสดงรายการของบันเดิลทั้งหมดที่มีชนิดที่ถูกอ้างอิงในบันเดิลที่ถูกค้นหา ถ้าเลือก รายงานบันเดิลที่อ้างอิง (Consumers) รายงานจะถูกจัดระเบียบให้แสดงบันเดิลทั้งหมดในขอบเขตการค้นหาที่มีการอ้างอิง

เมื่อสลับชนิดของรายงาน ให้ตรวจสอบว่านิพจน์ทั่วไป Reference to และ Bundles matching มีค่าที่ถูกต้อง เมื่อใช้นิพจน์ไวด์การ์ด เช่น .* ในการตั้งค่าหนึ่ง การสลับไปยังชนิดของรายงานอื่นมักต้องการให้ย้ายไวด์การ์ดไปยังการตั้งค่าอื่นเพื่อให้ได้รับรายงานที่มีประโยชน์ที่สุด

รายงานบันเดิลที่ถูกอ้างอิง (Producers)
การรายงาน > ตำแหน่งเอาต์พุตการรายงาน ยอมให้คุณระบุพาธสัมบูรณ์ที่รายงานที่สร้างขึ้นใดๆ ควรถูกวางอยู่ ว่างเปล่า
การรายงาน > เรียกดู... ยอมให้คุณเลือกตำแหน่งที่เอาต์พุตไปยังรายงานใดๆ  
การรายงาน > ล้างข้อมูลไดเร็กทอรีสำหรับการรายงานก่อนที่ผลลัพธ์ใหม่ของรายการ ยอมให้คุณเอาข้อคิดเห็นออกจากตำแหน่งรายงาน XML ที่มีอยู่ก่อนที่จะสแกนการรายงานผลลัพธ์ใดๆ ซึ่งควรแจ้งให้ทราบว่า อ็อพชันนี้จะถูกถอนออกจากไดเร็กทอรีรายงานที่ระบุไว้หากมีอยู่พร้อมกับไดเร็กทอรีชายด์ทั้งหมดที่ทำซ้ำการย้ายของด้วยเช่นกัน ยกเลิกการทำเครื่องหมาย
การรายงาน > สร้างรายงาน HTML แปลงเอาต์พุต XML ทั้งหมดลงใน HTML ที่จัดรูปแบบแล้วและวางไว้ใน <report location>\html ยกเลิกการทำเครื่องหมาย
การรายงาน > การล้างข้อมูลตำแหน่งของการรายงาน HTML ยอมให้คุณล้างข้อมูลตำแหน่ง HTML ที่มีอยู่ก่อนที่จะสร้างรายงานใหม่ ซึ่งควรแจ้งให้ทราบว่า อ็อพชันนี้จะถูกถอนออกจากไดเร็กทอรี HTML ที่ระบุไว้หากมีอยู่พร้อมกับไดเร็กทอรีชายด์ทั้งหมดที่ทำซ้ำการย้ายของด้วยเช่นกัน อ็อพชันนี้เปิดใช้งานหากคุณเลือกอ็อพชัน สร้างรายงาน HTML ตามที่กล่าวไว้ข้างต้น ยกเลิกการทำเครื่องหมาย
การรายงาน > เปิดรายงานเมื่อการค้นหาเสร็จสิ้น เปิดรายงาน HTML เมื่อการวิเคราะห์เสร็จสมบูรณ์ อ็อพชันนี้เปิดใช้งานหากคุณเลือกอ็อพชัน สร้างรายงาน HTML ตามที่กล่าวไว้ข้างต้น ยกเลิกการทำเครื่องหมาย
การรายงาน > คำอธิบาย ยอมให้คุณป้อนคำอธิบายที่มนุษย์สามารถอ่านได้สำหรับรายงาน ว่างเปล่า

แท็บรูปแบบ

แท็บ รูปแบบ ยอมให้คุณสร้างรูปแบบ นิพจน์ปกติ ที่หลากหลายเพื่อควบคุมการวิเคราะห์การใช้งาน ปัจจุบันมีชนิดของรูปแบบที่สนับสนุนสามรูปแบบ:

  1. รูปแบบไฟล์เก็บถาวร - ยอมให้คุณระบุไฟล์เก็บถาวรที่ซ้อนกันซึ่งควรถูกละเว้นในระหว่างการวิเคราะห์
  2. รูปแบบแพ็กเกจ - ยอมให้คุณระบุแพ็กเกจที่ควรเป็น API หรือภายในโดยไม่มีการอัพเดตบันเดิล manifest ของคุณ
  3. รูปแบบการแปลงรายงาน - ยอมให้คุณสร้างชื่อแพ็กเกจ นิพจน์ปกติ เพื่อกรองการอ้างถึงที่รายงาน การอ้างถึงรายงานทั้งหมดถูกกรอง โดยใช้ชื่อแพ็กเกจที่ผ่านการรับรองโดยสมบูรณ์

แท็บรูปแบบ


อ็อพชัน

คำอธิบาย

ดีฟอลต์

เพิ่ม... ยอมให้คุณเพิ่มรูปแบบใหม่ ปุ่มนี้จะเริ่มทำงานกับ ตัวช่วยสร้างรูปแบบ  
แก้ไข ยอมให้คุณแก้ไขรูปแบบที่เลือกไว้ในปัจจุบัน เฉพาะหนึ่งรูปแบบเท่านั้นที่สามารถแก้ไขได้ในแต่ละครั้ง  
การถอน ยอมให้คุณลบรูปแบบที่เลือกไว้ คุณสามารถลบได้มากกว่าหนึ่งรูปแบบในหนึ่งครั้ง  

ภารกิจที่เกี่ยวข้อง

การเปรียบเทียบกับ API พื้นฐาน
การตั้งค่าพื้นฐาน

การอ้างถึงที่เกี่ยวข้อง

การกำหนดค่าตามความชอบสำหรับ API พื้นฐาน
ตัวช่วยสร้างรูปแบบการใช้ API