jsdoc

วันนี้อยากจะมาเขียนถึงเรื่องการทำเอกสารประกอบโค้ดหรือว่า code document ในภาษา JavaScript กันครับ จริงๆ แล้วเราสามารถทำได้หลายวิธี แต่หนึ่งในวิธีที่นิยมที่สุดคือการใช้ JSDoc ซึ่งเป็นมาตรฐานในการเขียน comments ที่สามารถใช้สร้าง document แบบอัตโนมัติได้ ตัวอย่างการทำ Code Document โดยการใช้ JSDoc อธิบายตัวอย่างด้านบน สรุป การใช้ JSDoc จะช่วยให้ผู้อื่นสามารถอ่านโค้ดของเราเข้าใจถึงการทำงานของ function และ class ต่าง ๆ ได้ง่ายขึ้น และยังสามารถใช้เครื่องมืออัตโนมัติสร้าง document จาก comments เหล่านี้ได้อีกด้วย