คู่มืออ้างอิงรูปแบบเอาต์พุต
หน้านี้อธิบายไวยากรณ์ของเอาต์พุต .skt และเอาต์พุต JSON ที่เทียบเท่า สำหรับกฎที่ตัดสินว่าความสัมพันธ์ถูกแก้ไขอย่างไร โปรดดูที่ การรองรับภาษาและความเที่ยงตรงของ API
ไฟล์ .skt เป็นไฟล์ข้อความขนาดกะทัดรัดที่ประกอบด้วยส่วนต่าง ๆ แต่ละส่วนเริ่มต้นด้วยบรรทัดหัวเรื่องในวงเล็บเหลี่ยม
| ส่วน | มีอยู่เมื่อ | เนื้อหา |
|---|---|---|
[symbols] |
เสมอ | นิยามสัญลักษณ์ที่จัดกลุ่มตามไฟล์ต้นฉบับ |
[edges] |
--edges ถูกตั้งค่า |
ความสัมพันธ์ระหว่างสัญลักษณ์ |
[errors] |
เกิดการวินิจฉัยการสแกนหรือการแยกวิเคราะห์ | ไฟล์ที่ไม่สามารถประมวลผลได้อย่างสมบูรณ์ |
[dict] |
--minify ถูกตั้งค่า |
พจนานุกรมที่จับคู่รหัสสั้นกับโทเค็นที่ซ้ำกัน |
ในโหมดเอาต์พุตไดเรกทอรี ส่วน [errors] และ [dict] สามารถเขียนลงในไฟล์เสริม warnings.skt และ dict.skt ได้ ในโหมด inline ส่วนเหล่านี้จะปรากฏในเอาต์พุตเดียวกันกับส่วนอื่น ๆ
--format json จะสร้างเอกสาร JSON ที่มีข้อมูลเดียวกัน ดู เอาต์พุต JSON
[symbols]
หัวข้อที่มีชื่อว่า “[symbols]”สัญลักษณ์จะถูกจัดกลุ่มตามไฟล์ต้นฉบับ แต่ละกลุ่มเริ่มต้นด้วยบรรทัดหัวเรื่อง ## <path> ตามด้วยบรรทัดละหนึ่งสัญลักษณ์
[symbols]## pkg/services/auth.goS1 module/package L1-L1 services {}S2 type/struct L5-L8 AuthService {exported}บรรทัดสัญลักษณ์
หัวข้อที่มีชื่อว่า “บรรทัดสัญลักษณ์”ShortID category/kind Lstart-Lend signature {properties}| ฟิลด์ | คำอธิบาย |
|---|---|
ShortID |
ตัวระบุตามลำดับ: S1, S2, S3 เป็นต้น เส้นเชื่อมอ้างอิงสัญลักษณ์ด้วยค่านี้ |
category/kind |
การจำแนกประเภทของสัญลักษณ์ ดู หมวดหมู่และประเภท |
Lstart-Lend |
บรรทัดแรกและบรรทัดสุดท้ายของสัญลักษณ์ในไฟล์ต้นฉบับ |
signature |
ชื่อสัญลักษณ์ พร้อมพารามิเตอร์และประเภทการคืนค่าสำหรับ callable ดู รูปแบบลายเซ็น |
{properties} |
ข้อมูลเมตาในวงเล็บปีกกา ดู คุณสมบัติ |
บรรทัดสัญลักษณ์จะอยู่ในบรรทัดเดียว การขึ้นบรรทัดใหม่ภายในลายเซ็นจะถูกแทนที่ด้วย \n และ \r
รหัสสัญลักษณ์สามารถเปลี่ยนแปลงได้เมื่อการดึงข้อมูลเปลี่ยนแปลง ควรสร้างชิ้นส่วนเอาต์พุตทั้งหมดพร้อมกันแทนที่จะผสมชิ้นส่วนจากการรันที่ต่างกัน สิ่งนี้มีความสำคัญโดยเฉพาะเมื่ออัปเกรดเป็น 0.5.0 เนื่องจากรหัสสัญลักษณ์และผลลัพธ์การแก้ไขความสัมพันธ์อาจเปลี่ยนแปลงได้
หมวดหมู่และประเภท
หัวข้อที่มีชื่อว่า “หมวดหมู่และประเภท”| หมวดหมู่ | ประเภท | ตัวอย่าง |
|---|---|---|
callable |
function, method, constructor | callable/function, callable/method |
type |
class, interface, struct, enum | type/class, type/interface |
value |
variable, constant, field | value/variable, value/constant |
module |
package, namespace | module/package |
meta |
type parameters, files, includes, metadata | meta/type_parameter, meta/file, meta/include |
รูปแบบลายเซ็น
หัวข้อที่มีชื่อว่า “รูปแบบลายเซ็น”| รูปแบบ | ใช้สำหรับ |
|---|---|
name |
ประเภท ค่า และโมดูล |
name(params) |
Callable ที่ไม่มีประเภทการคืนค่า |
name(params) -> returnType |
Callable ที่มีประเภทการคืนค่า |
พารามิเตอร์เขียนเป็น:
| รูปแบบ | ใช้สำหรับ |
|---|---|
name |
ภาษาที่ไม่มีประเภท |
name: type |
ภาษาที่มีประเภท |
เมื่อการอ้างอิงประเภทตรงกับสัญลักษณ์ที่รู้จัก ชื่อประเภทจะถูกแทนที่ด้วยรหัสสั้นของสัญลักษณ์นั้น ตัวอย่างเช่น -> *S2 อ้างอิงถึงตัวชี้ไปยังสัญลักษณ์ S2
คุณสมบัติ
หัวข้อที่มีชื่อว่า “คุณสมบัติ”คุณสมบัติปรากฏในวงเล็บปีกกาหลังลายเซ็น คั่นด้วยเครื่องหมายจุลภาค วงเล็บปีกกาว่าง ({}) หมายความว่าสัญลักษณ์นั้นไม่มีคุณสมบัติ
| รูปแบบคุณสมบัติ | ตัวอย่าง |
|---|---|
| Flag | exported, async, static |
key=value |
visibility=public, receiver=*AuthService, exported=false, resolution=unresolved |
ตัวอย่าง
หัวข้อที่มีชื่อว่า “ตัวอย่าง”[symbols]## pkg/services/auth.goS1 module/package L1-L1 services {}S2 type/struct L5-L8 AuthService {exported}S3 callable/function L10-L12 NewAuthService(secret: string, ttl: int) -> *S2 {exported}S4 callable/method L14-L19 Authenticate(token: string) {exported, receiver=*AuthService}S5 callable/function L29-L31 verifyToken(token: string) -> bool {exported=false}[edges]
หัวข้อที่มีชื่อว่า “[edges]”ส่วน [edges] แสดงรายการความสัมพันธ์ระหว่างสัญลักษณ์ จะถูกเขียนเมื่อมีการร้องขอเส้นเชื่อมด้วย --edges
บรรทัดเส้นเชื่อม
หัวข้อที่มีชื่อว่า “บรรทัดเส้นเชื่อม”FromID --kind--> ToID1, ToID2FromID --kind[unresolved]--> Target1, Target2FromID --kind[ambiguous]--> Target [candidates=CandidateID1, CandidateIDID2]| ส่วน | คำอธิบาย |
|---|---|
FromID |
จุดสิ้นสุดต้นทาง |
kind |
ประเภทความสัมพันธ์ ดู ประเภทเส้นเชื่อม |
[unresolved], [ambiguous] |
เครื่องหมายการแก้ไขที่ไม่บังคับ ดู เครื่องหมายการแก้ไข |
ToID1, ToID2 |
เป้าหมายหนึ่งหรือหลายเป้าหมาย คั่นด้วยเครื่องหมายจุลภาค |
[candidates=...] |
เป้าหมายที่เป็นไปได้สำหรับเส้นเชื่อมที่คลุมเครือ เป็นรายการที่คั่นด้วยเครื่องหมายจุลภาคในวงเล็บ |
เป้าหมายจะใช้บรรทัดเดียวกันเมื่อต้นทาง ประเภท เครื่องหมายการแก้ไข และชุดผู้สมัครเหมือนกัน นิยามที่อ้างอิงโดยเส้นเชื่อมสามารถเกิดขึ้นในไฟล์หรือชิ้นส่วนเอาต์พุตในภายหลัง โหลดชิ้นส่วนทั้งหมดก่อนตีความเส้นเชื่อม
เครื่องหมายการแก้ไข
หัวข้อที่มีชื่อว่า “เครื่องหมายการแก้ไข”| เครื่องหมาย | ความหมาย |
|---|---|
| ไม่มี | เครื่องมือวิเคราะห์สามารถแก้ไขความสัมพันธ์ได้ |
[unresolved] |
เครื่องมือวิเคราะห์ไม่สามารถสร้างการพึ่งพาได้ |
[ambiguous] |
มีการตีความที่เป็นไปได้มากกว่าหนึ่งแบบ รหัสผู้สมัครแสดงรายการเป้าหมายที่เป็นไปได้ |
การไม่มีเครื่องหมายไม่ได้เป็นการรับประกันจากคอมไพเลอร์ รหัสผู้สมัครระบุเป้าหมายที่เป็นไปได้ ไม่ใช่การเชื่อมต่อที่ยืนยัน ความไม่แน่นอนจะถูกเขียนในไวยากรณ์ SKT นี้เสมอ ไม่ใช่เป็น JSON ที่ฝังอยู่
รูปแบบจุดสิ้นสุด
หัวข้อที่มีชื่อว่า “รูปแบบจุดสิ้นสุด”| รูปแบบ | เมื่อใช้ | ตัวอย่าง |
|---|---|---|
| Short ID | จุดสิ้นสุดหรือผู้สมัครเป็นสัญลักษณ์ที่รู้จัก ซึ่งรวมถึงจุดสิ้นสุดของเส้นเชื่อมที่ไม่ได้แก้ไขและสัญลักษณ์ include | S4, S8 |
| ชื่อเปล่า | เป้าหมายไม่มีสัญลักษณ์ ชื่อจะสัมพันธ์กับไฟล์ต้นทาง | Refresh, string |
| Quoted full ID | รหัสประจำตัวมีความซับซ้อน หรือชื่อตามตัวอักษรคล้ายกับ Short ID | "app.go::S2" |
Quoted full ID จะหลีกเลี่ยงเครื่องหมายคำพูด เครื่องหมายแบ็กสแลช และการขึ้นบรรทัดใหม่ ชื่อตามตัวอักษรเช่น S2 ต้องเขียนเป็น quoted full ID เพื่อไม่ให้ถูกอ่านเป็น Short ID
S4 --references[unresolved]--> string, boolS5 --calls[ambiguous]--> Helper [candidates=S8, S9]S6 --references[unresolved]--> "app.go::S2"ประเภทเส้นเชื่อม
หัวข้อที่มีชื่อว่า “ประเภทเส้นเชื่อม”| ประเภท | ความหมาย |
|---|---|
calls |
การเรียกใช้ฟังก์ชัน/เมธอด |
contains |
คลาสมีเมธอด โมดูลมีฟังก์ชัน |
inherits |
คลาสขยายคลาสอื่น |
implements |
คลาสใช้งานอินเทอร์เฟซ |
overrides |
เมธอดแทนที่เมธอดหลัก |
references |
สัญลักษณ์อ้างอิงถึงสัญลักษณ์อื่น |
imports |
โมดูลนำเข้าโมดูลอื่น |
decorates |
เดคอเรเตอร์ถูกนำไปใช้กับสัญลักษณ์ |
Callable ที่ถูกคืนค่าและอาร์กิวเมนต์ callback จะถูกบันทึกเป็น references ไม่ใช่เป็นประเภทแยกต่างหาก
สัญลักษณ์ไฟล์และ include ของ C และ C++
หัวข้อที่มีชื่อว่า “สัญลักษณ์ไฟล์และ include ของ C และ C++”ซอร์สโค้ด C และ C++ จะสร้างสัญลักษณ์ meta/file และ meta/include ดังนั้นความสัมพันธ์ include จึงมี Short ID การสะกดหัวข้อแต่ละครั้งจะปรากฏหนึ่งครั้งในรายการสัญลักษณ์ และเส้นเชื่อมจะใช้ Short ID การ include ซ้ำภายในไฟล์จะใช้จุดสิ้นสุดเดียวกัน
[symbols]## src/main.cS1 meta/file L1-L4 main.cS2 meta/include L1-L1 "config.h" {resolution=unresolved}S3 meta/include L2-L2 "utils.h" {resolution=unresolved}S4 meta/include L3-L3 <stdio.h> {resolution=unresolved}
[edges]S1 --references[unresolved]--> S2, S3, S4สัญลักษณ์ include จะบันทึกคำสั่งตามที่เขียน ไม่ได้แสดงถึงการประกาศหัวข้อที่ถูกแก้ไข
ผลกระทบต่อการวิเคราะห์และการแสดงภาพ
หัวข้อที่มีชื่อว่า “ผลกระทบต่อการวิเคราะห์และการแสดงภาพ”- เส้นเชื่อมที่ไม่แน่นอนและข้อมูลเมตาไฟล์/include จะไม่ถูกนำมาพิจารณาในการวัดการพึ่งพา รายงานจะแสดงจำนวนความสัมพันธ์ที่ถูกยกเว้น
- กราฟ HTML จะวาดเส้นเชื่อมที่ถูกแก้ไขและแสดงจำนวนความสัมพันธ์ที่ไม่แน่นอน แต่จะไม่วาดเส้นเชื่อมที่ไม่แน่นอนแต่ละรายการ
ตัวอย่าง
หัวข้อที่มีชื่อว่า “ตัวอย่าง”[edges]S2 --contains--> S4S4 --calls--> S5S10 --inherits--> S2S24 --implements--> S19[errors]
หัวข้อที่มีชื่อว่า “[errors]”ส่วน [errors] แสดงรายการไฟล์ที่ไม่สามารถประมวลผลได้อย่างสมบูรณ์ จะมีอยู่เมื่อมีการวินิจฉัยเท่านั้น
- <path>: <message>[errors]- path/to/broken.go: syntax error at line 42ส่วน [dict] จะปรากฏเฉพาะในเอาต์พุตที่ถูกย่อ (--minify) จะจับคู่รหัสสั้นกับโทเค็นที่ซ้ำกัน
| ส่วน | คำอธิบาย |
|---|---|
d0, d1, … |
รหัสพจนานุกรม |
| บรรทัดรายการ | - <code>: <token> |
ในการอ่านเอาต์พุตที่ถูกย่อ ให้แทนที่แต่ละรหัสด้วยค่าจากพจนานุกรม รหัสสามารถแทนที่คู่หมวดหมู่/ประเภทและคุณสมบัติใน [symbols] ได้ นอกจากนี้ยังสามารถแทนที่ประเภทความสัมพันธ์ใน [edges] ได้ เครื่องหมายความไม่แน่นอนยังคงอ่านได้ ตัวอย่างเช่น S1 --d2[unresolved]--> S3 เป็นเส้นเชื่อมที่ไม่ได้แก้ไขซึ่งประเภทคือค่าของ d2
ตัวอย่างที่ถูกย่อ
หัวข้อที่มีชื่อว่า “ตัวอย่างที่ถูกย่อ”[dict]- d0: async=false- d1: callable/method- d2: exported
[symbols]## src/handler.pyS1 type/class L1-L6 Handler {}S2 d1 L2-L3 __init__(name) {d0}S3 d1 L5-L6 handle(request) {d0}
[edges]S1 --contains--> S2, S3ที่นี่ S2 เป็น callable/method ที่มีคุณสมบัติ async=false
ตัวอย่างเต็มรูปแบบ
หัวข้อที่มีชื่อว่า “ตัวอย่างเต็มรูปแบบ”เอาต์พุตต่อไปนี้ประกอบด้วย [symbols], [edges] และ [errors] ไม่ได้ถูกย่อ จึงไม่มีส่วน [dict] ดู ตัวอย่างที่ถูกย่อ
[symbols]## pkg/services/auth.goS1 module/package L1-L1 services {}S2 type/struct L5-L8 AuthService {exported}S3 callable/function L10-L12 NewAuthService(secret: string, ttl: int) -> *S2 {exported}S4 callable/method L14-L19 Authenticate(token: string) {exported, receiver=*AuthService}S5 callable/function L29-L31 verifyToken(token: string) -> bool {exported=false}## pkg/util/hash.goS6 callable/function L3-L5 Hash(data: string) -> string {exported}## pkg/util/hash_alt.goS7 callable/function L3-L5 Hash(data: string) -> string {exported}
[edges]S1 --contains--> S2, S3, S4, S5S2 --contains--> S4S3 --references--> S2S4 --calls--> S5S4 --calls[unresolved]--> RefreshS5 --calls[ambiguous]--> Hash [candidates=S6, S7]
[errors]- pkg/legacy/broken.go: syntax error at line 42เอาต์พุต JSON
หัวข้อที่มีชื่อว่า “เอาต์พุต JSON”--format json