summary

<summary>

เครื่องกำเนิดอ้างอิง API ที่ยืดหยุ่นและง่ายดายสำหรับ. NET

การใช้งาน

ปัจจุบันเครื่องกำเนิดไฟฟ้ายังเด็ก ในการใช้งานคุณควรดาวน์โหลด Summary (Core), Summary.Roslyn (parser) และ Summary.Markdown (renderer) แพ็คเกจ

นี่คือรหัสย่อโค้ดง่ายๆที่แยกวิเคราะห์ไฟล์ในไดเรกทอรีที่ระบุและแสดงผลเป็นรูปแบบ markdown:

 // The folder you want to parse the `*.cs` files from.
const string input = "./src" ;

// The folder you want to put the generator output into.
const string output = "./docs" ;

await new SummaryPipeline ( )
    . UseRoslynParser ( input )
    . UseMdRenderer ( output )
    . UseDefaultFilters ( )
    . Run ( ) ; 

ตัวอย่าง

พิจารณาตรวจสอบไดเรกทอรี DOCS: เป็นบท Summary สรุปที่สร้างขึ้นโดย Summary