[Java] Java Library & Java Docs

การเขียนโปรแกรม Java บางครั้งเราอาจจะไปหา Source Code มาจากเว็บต่างๆ แล้วอาจใช้งานไม่ได้ หรือ เขียนตามหนังสือ อะไรก็ตามแต่ แล้วใช้งานไม่ได้ ลองเปรียบเทียบดูแล้วก็ไม่มีอะไรผิด Editor ก็บอกว่าไม่รู้จัก Class ที่เราใช้ ซึ่ง import ก็ error อะไรก็ไม่รู้ บางทีเราอาจจะลืม import library เข้ามาครับ
library ที่ว่านี้คือ package และ class ต่างๆ ที่ไม่ได้อยู่ใน JDK ครับ

สำหรับวิธีการ import ให้ทำการคลิกขวาที่ library ใน project ของเราครับ จากนั้นเลือกลักษณะ library ของเรา ซึ่งส่วนใหญ่จะเป็น JAR ครับ ก็ Add JAR/Folder...

เลือกไฟล์ .jar ที่เราต้องการ import ครับ กด Open ก็เป็นอันใช้ได้

ทีนี้เราก็สามารถ import class ต่างๆ จาก library นี้ ลงสู่โปรแกรมของเราได้แล้วครับ ทำให้สามารถใช้งานได้ตามปกติ แต่ปัญหาอยู่ที่ เมื่อเรากด Ctrl + Space ซึ่งเป็นคีย์ลัดสำหรับการแสดง Code Completion ใน NetBeans IDE (Editor อื่นๆ ก็มักใช้คีย์ลัดแบบเดียวกัน) จะปรากฏดังภาพ คือ ไม่เจอ Javadoc ซึ่งเป็นรายละเอียดของฟังก์ชันต่างๆ ของ library ที่เรา import เข้ามา ทำให้บางทีก็ทำให้เราใช้งานไม่ถูก

วิธีการ import Javadoc ทำได้โดยการคลิกขวาที่ library ที่ต้องการใส่ Javadoc แล้วเลือก Edit... จะปรากฏหน้าจอ Edit Jar Reference ขึ้นมา ให้ทำการ Browse หา Folder ที่เป็น apidocs ขึ้นมาครับ ซึ่ง apidocs จะเป็น html หลายๆ ไฟล์ครับ

ถ้า Javadoc หรือ apidocs ที่เราใส่เข้ามาสามารถใช้ได้จริง จะทำให้รายละเอียดของฟังก์ชันต่างๆของ library นั้นปรากฏสู่สายตาของเราครับ

ทีนี้ มีเกร็ดเพิ่มเติมอีกนิดหน่อยครับ หาก class ที่เรา import เข้ามานั้นเป็น class ที่เราเขียนไว้ก่อนหน้าอีกที ก็มีวิธีที่เราจะสร้าง javadoc ของเราเองครับ เป็นการ comment ไว้บนหัวฟังก์ชันที่เราต้องการพิมพ์ Javadoc ครับ

/**
* This is Javadoc
*
*/

นอกจากนี้เรายังสามารถบอกรายละเอียดของ parameter, สิ่งที่ return, exception หรืออื่นๆ ให้กับฟังก์ชันเราได้ โดยผมจะยกตัวอย่าง Javadoc ที่เห็นบ่อยๆ ก็มักจะใช้ประมาณนี้ครับ ให้ลองสังเกตวิธีบอกรายละเอียดของ parameter หรืออื่นๆ ดูครับ

/**
* This function is example to use javadoc it will return only summation of 2 parameters.
* @param number1 first value
* @param number2 second value
* @return result of first value add by second value
*/
public int easySummation(int number1, int number2)
{
     return number1 + number2;
}

เมื่อเรา Generate Javadoc (คลิกขวาที่ project -> Genarate Javadoc) จะให้ผลลัพธ์ดังนี้ครับ

public int easySummation(int number1, int number2)

This function is example to use javadoc it will return only summation of 2 parameters.
Parameters:
     number1 - first value
     number2 - second value
Returns:
     result of first value add by second value


ทีนี้ก็ลองเอาไปใช้ดูนะครับ เผื่อมีใครเอา class ที่เราเคยเขียนไว้ไปใช้ต่อ ถ้าเรา comment ไว้และมี javadoc ให้แบบนี้ การนำไปใช้ก็เป็นอะไรที่ไม่ยากนักครับ หากต้องการศึกษาวิธีใช้ javadoc เพิ่มเติม ตาม ลิงค์ https://www.oracle.com/technetwork/java/javase/documentation/index-137868.html ไปเลยครับ