วันเสาร์ที่ 6 พฤศจิกายน พ.ศ. 2553

บันทึก Note ของ Rails Project

เมื่อโปรเจค Rails มันใหญ่ขึ้น แล้วตรวจสอบพบว่า มีจุดบกพร่องแต่ก็ยังไม่อยากแก้ตอนนี้ (ไม่ว่าจะด้วยสาเหตุใดก็ตาม) แต่ก็ต้อง Note ไว้ก่อน

หรือ ในกรณีที่คล้ายๆกัน ระหว่างที่เขียนโปรแกรมไปเรื่อยๆ นึง Feature ใหม่ๆ ขึ้นมาได้ แล้วก็อยากจะ Note ไว้ก่อนแล้วค่อยมาทำทีหลัง

แล้วพอ comment ไปเยอะๆเข้า หรือ ปล่อยไว้นานๆ ก็ยังไม่เข้าไปแก้ไข จนลืม (ต้องคอยมานั่งเปิดไฟล์ เพื่อหาตำแหน่ง ที่ comment ไว้)

ปัญหาเหล่านี้ Rails มีคำสั่งให้แล้วครับ อยู่ใน rake notes (ถ้าอยากดูว่า rake มีคำสั่งทั้งหมดใช้ rake -T)

โดยมีรายละเอียดดังนี้

rake notes # Enumerate all annotations
rake notes:custom # Enumerate a custom annotation, specify with ANNOTATION=WTFHAX
rake notes:fixme # Enumerate all FIXME annotations
rake notes:optimize # Enumerate all OPTIMIZE annotations
rake notes:todo # Enumerate all TODO annotations


ตัวอย่างการใช้งาน ในไฟล์ controller
def create
# TODO: need to implement
end

จากนั้นให้ออกมาที่ command ของ linux แล้วลองพิมพ์คำสั่ง

# rake notes
หรือ
# rake notes:todo

ทีนี้พอเราทำงานไปเรื่อยๆ ถ้าเจออะไรผิดพลาด หรือ ต้องย้อนกลับมาทำในภายหลังก็ให้ comment เอาไว้ก่อน แล้สพอว่างๆก็ใช้คำสั่ง rake เรียกกลับมาดูได้แล้วนะครับ

ไม่มีความคิดเห็น:

แสดงความคิดเห็น