สิ่งที่พบเจอบ่อย ๆ สำหรับการเขียน code คือ
ไม่ยอมเขียนเอกสารอธิบายการทำงานของ code
ถ้า code อ่านรูปเรื่องก็ว่าไปอย่าง
ยิ่งต้องมาทำงานเป็นทีมยิ่งสนุกไปกันใหญ่
ตัวอย่างเช่น ภาษา JavaScript ยิ่งไม่ค่อยเขียนกัน
ใช้งานใน VS Code ก็ไม่ช่วยแนะนำอะไรเลย
ทั้งไม่อธิบาย function/module รวมทั้ง type ต่าง ๆ
หลาย ๆ คนเลยอยากจะเปลี่ยนไปเขียนด้วย TypeScript ด้วยซ้ำ
ดังนั้นจึงแนะนำ หรือ พาทำก่อนคือ เขียนเอกสารอธิบาย code ด้วย JSDoc ก่อน
เพื่อช่วยอธิบายการใช้งาน code ทั้ง
- module
- function
ส่วน README อธิบายภาพรวมก็ยังคงต้องมีเช่นเดิม
ดังนั้นมาหัดเขียนกันเถอะนะครับ จะได้ไม่เป็นภาระต่อไป
ตัวอย่างเช่น
ทำการเขียนอธิบาย function ว่าทำงานอะไร
- parameter แต่ละตัวมี data type อย่างไร ถ้าเป็น object ก็ระบุรายละเอียดไป
- มียกตัวอย่างการใช้งานอีกด้วย
ในการเขียน code นั้น ผู้ใช้งานก็จะเห็นแบบนี้ใน VS Code
น่าจะดีกว่าเดิมไหม ?
แถมยังเขียนด้วย Markdown format ได้อีก
ลองฝึกใช้งานกันดู
