อย่าปล่อยให้ความคิดเห็นซ่อนอยู่ในซอร์สโค้ดของคุณ! อ่าน ค้นหา และเผยแพร่ด้วย Live Documenter เอกสารสำหรับ .NET ทำได้ง่าย
Live Documenter คือชุดแอปพลิเคชันและไลบรารีที่เปิดใช้งานการดูสดและการสร้างเอกสารอัตโนมัติจากโค้ด .NET และไฟล์ความคิดเห็น xml เรียนรู้ว่า Live Documenter คืออะไรจากหน้าแรกของเราและดาวน์โหลดเวอร์ชันล่าสุด
ดูเอกสารสดและอัปเดต!
สร้างเอกสารคงที่ที่สวยงาม
หรือใช้ไลบรารี API เพื่อรวมเข้ากับโปรเจ็กต์ของคุณเอง
Live Documenter เป็นแอปพลิเคชันเดสก์ท็อป คอนโซลยูทิลิตี้ และไลบรารี API ที่ออกแบบมาเพื่อทำให้โค้ด .NET และความคิดเห็นของคุณอ่านง่ายขึ้นและพร้อมใช้งานมากขึ้น ปลดปล่อยพวกมันออกจากขอบเขตของ xml ที่กระจัดกระจายอยู่ในซอร์สโค้ดของคุณ และนำไปใช้ให้เกิดประโยชน์!
เริ่มต้นด้วยการดาวน์โหลดเวอร์ชันล่าสุดและอ่านคู่มือเริ่มต้นใช้งานฉบับย่อ
แอปพลิเคชันเดสก์ท็อปช่วยให้สามารถเปิดโครงการ Visual Studio โซลูชันหรือไลบรารีและสร้างเอกสารประกอบจากไฟล์ความคิดเห็น XML ได้ หากมีการเปลี่ยนแปลงกับโค้ดเบส สิ่งเหล่านี้จะสะท้อนให้เห็นในแอปพลิเคชันเมื่อมีการสร้างโปรเจ็กต์ใหม่
นอกจากนี้ยังมีอินเทอร์เฟซที่ดีสำหรับการส่งออกเอกสาร การอ่าน และการพิมพ์
แอปพลิเคชันผู้ส่งออกมีประโยชน์สำหรับการรวมการสร้างเอกสารเข้ากับกระบวนการที่มีอยู่ เช่นสคริปต์การสร้างของคุณหรือการสร้างเอกสารเฉพาะกิจ
DLL ที่โปรเจ็กต์สามารถอ้างอิงได้เพื่อสร้างเอกสารประกอบอัตโนมัติขณะรันไทม์ รายละเอียดของ API และวิธีการใช้งานสามารถพบได้ในเอกสารประกอบ
ในขณะนี้จะใช้งานได้เฉพาะบน Windows เท่านั้น งานกำลังดำเนินการถ่ายโอนไปยัง netstandard และทำทุกอย่างยกเว้นแอปพลิเคชันเดสก์ท็อปข้ามแพลตฟอร์มบน .NET Core
มีไฟล์ zip เวอร์ชันล่าสุดมาให้ หากต้องการติดตั้ง ให้ดาวน์โหลดไฟล์ แตกไฟล์และดำเนินการจากไดเร็กทอรี
ความต้องการ
.NET Core SDK 3.1
รหัสล่าสุดได้รับการพัฒนาใน Visual Studio 2019 และหลายโครงการได้ถูกถ่ายโอนไปยังไลบรารี netstandard และใช้รูปแบบไฟล์ csproj ล่าสุด
โปรดแจ้งให้เราทราบหากมีปัญหาใดๆ ในการสร้างจากแหล่งที่มา เพื่อให้เราสามารถแก้ไขปัญหาได้
ความช่วยเหลือทั้งหมดได้รับการชื่นชม มีไซต์เอกสารที่เกี่ยวข้องซึ่งสามารถปรับปรุงได้เสมอ
หากคุณต้องการมีส่วนร่วมในโครงการ โปรดดูปัญหาในปัจจุบัน จดบันทึกความสนใจของคุณ รับเวอร์ชันล่าสุด และสร้างคำขอดึงเมื่อคุณพร้อมที่จะรวมการเปลี่ยนแปลง
นอกจากนี้ การให้ข้อเสนอแนะผ่านปัญหา GitHub ก็ช่วยให้แน่ใจว่าโปรเจ็กต์มีความเสถียรมากขึ้นและได้รับการปรับปรุงอย่างต่อเนื่อง