Lab 5 – JavaDoc Comments


วัตถุประสงค์:

โปรแกรมนี้เป็นโปรแกรมแข่งวิ่งของกระต่ายกับเต่า โดยจะเปรียบสนามแข่งเป็นตาราง 8x8 จุดเริ่มต้นอยู่ที่ 0, 0 และจุดสิ้นสุดอยู่ที่ 0, 7 เพื่อให้กระต่ายและเต่าอย่างละ 3 ตัววิ่งไปตามตารางให้ถึงเส้นชัย (ทุกตัวอยู่ทับช่องกันได้) โดยแต่ละช่องของตารางเดินทาง อาจมีกับดักที่วางไว้ ซึ่งกระต่ายและเต่าจะต้องทำตามกับดักนั้น เช่น อาจให้เดินหน้า-ถอยหลัง หรือหยุดเดิน เป็นต้น

1. รายละเอียดของ Class ต่างๆที่ต้องใช้ในโปรแกรมมีดังนี้

Class Animal : class นี้จะเป็น abstract class เพื่อให้ Rabbit และ turtle extends ต่อไป มีนิยาม attribute และ function ต่างๆดังนี้

•  attribute

•  function: function เหล่านี้จะถูก implement ใน inherited class ให้กระทำฟังก์ชั่นในรูปแบบที่ต่างๆกัน แต่ใน class นี้แค่กำหนดว่ามี function อะไรบ้างเท่านั้น

 

Class Rabbit: class นี้ให้ extends class animal โดยมี function ต่างๆดังนี้

 

Class Turtle: class นี้ให้ extends class animal เช่นเดียวกับ Rabbit โดยต้อง implement function ต่างๆดั้งนี้

ส่วน class อื่นๆหรือฟังก์ชั่นต่างๆสามารถเพิ่มได้ตามใจชอบค่ะ และเวลาเขียน code ให้ทุกคนเขียน java doc อธิบายด้วยนะคะ

ตัวอย่างการเขียน java doc ในคลาส Animal

 (ใช้ export ใน eclipse สร้างหน้าเว็บของมันขึ้นมาดูสิ)

หลังจากที่นิสิตเขียน java doc กันเรียบร้อยแล้ว ลอง เรียกใช้ฟังก์ชั่นหรือคลาสที่เขียน java doc กันดูนะคะ เช่น

จะเห็นว่ามีคำอธิบายอยู่ในฟังก์ชั่นที่เราเขียน javadoc ไว้ หากคนที่นำคลาสของเราไปพัฒนาต่อได้อ่าน comment นี้ ก็จะทำให้เค้าเข้าใจและพัฒนาโปรแกรมได้เร็วขึ้นมาก เพราะฉะนั้น อย่าละเลยการเขียน comment หรือ javadoc นะคะ

2. สำหรับการเดินของแต่ละช่องเดิน มีข้อกำหนดดังนี้