ทำ functional design อย่างง่ายด้วยโปรแกรม Sandcastle Help File Builder

เมื่อพัฒนาโปรแกรมเสร็จแล้ว ก็ถึงเวลาทำเอกสารการเขียนอธิบายโค้ดต่อ บางครั้งมันยุ่งยากเสียเวลา วันนี้มีวิธีที่สะดวกและรวดเร็วเพียงแค่เขียนอธิบายใน Class ที่เราต้องการอธิบาย เช่น Constructors, Properties, methods

ตัวอย่างการเขียนอธิบายโค้ด

โดยทั่วไปแล้วการเขียน Logic ต่างๆ เพื่อนำไปใช้งานต่อหรืออ้างอิงโค้ดที่เราเขียนมักจะ build code เป็นไฟล์ .dll เพื่อให้ระบบอื่นมาเชื่อมต่อและเรียกใช้งานได้ โดยขั้นตอนแรกเราใช้โปรแกรม Sandcastle Help File Builder สามารถอ่านรายละเอียดเพิ่มเติมตามลิ้งก์ https://github.com/EWSoftware/SHFB/releases และ download และติดตั้งตามลิ้งก์

SHFBInstaller_v2019.11.17.0.zip 45.1 MB

เมื่อติดตั้งเสร็จเรียบร้อย หน้าตาก็จะประมาณนี้

โปรแกรม Sandcastle Help File Builder

ก่อนอื่นเราต้องไปตั้งค่าการ build code ใน Visual Studio ในส่วนของ XML ตามไฮไลต์สีเหลือง

การตั้งค่า XML ใน Visual Studio

จากนั้นก็กด Build ใน Visual Studio

แสดงการ Build ใน Visual Studio

เมื่อ build เสร็จ เราจะได้ไฟล์ .dll และ .xml

ไฟล์ .dll และ .xml

เมื่อได้ไฟล์ .dll และ .xml เรียบร้อยแล้ว ก็เพิ่มในโปรแกรม Sandcastle Help File Builder โดยไปที่เมนู File > Project Explorer > Documentation Sources > Add Documentation Source

เมนูการเพิ่ม Add Documentation Source

เมื่อเลือกไฟล์ .dll และ .xml เรียบร้อยแล้ว ผลลัพธ์ที่ได้แสดงตามภาพ

แสดงผลลัพธ์เมื่อ Add Documentation Source เสร็จ

จากนั้นตั้งค่าเมนู Help File ตามตัวอย่างข้างล่าง

ตั้งค่าเมนู Help File

จากนั้นตั้งค่าเมนู Visibility ตามตัวอย่างข้างล่าง

ตั้งค่าเมนู Visibility

เมื่อตั้งค่าโปรแกรมเสร็จเรียบร้อยแล้ว ไปที่เมนู Documentation > Build Project

เมนู Documentation > Build Project

รอโปรแกรมประมวลผลสักครู่ เราก็จะได้ไฟล์ .chm ออกมา

ไฟล์ .chm

เมื่อเปิดไฟล์ .chm เราก็จะได้ผลลัพธ์ Help File ตามรูปแบบที่แสดงตามภาพด้านล่าง

ผลลัพธ์ Help File 1
ผลลัพธ์ Help File 2
ผลลัพธ์ Help File 3
ผลลัพธ์ Help File 4

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.