JavaDoc adalah alat untuk mengekstrak informasi dari source code Java dan mengubah komentar Javadoc menjadi dokumentasi HTML. Javadoc digunakan untuk mendokumentasikan class, interface, dan method, serta fitur lainnya dengan tag kustom. Komentar Javadoc ditulis oleh programmer di source code dan kemudian diolah menjadi halaman dokumentasi.

1. JavaDoc
By Group 2

2. Apa itu JavaDoc?
JavaDoc adalah sebuah alat untuk mengekstrak
informasi dari source file java untuk membuat sebuah
API
Biasanya JavaDoc digunakan untuk
mendokumentasikan class, interfaces dan method
Tetapi juga bisa digunakan untuk
mendokumentasikan apapun dengan menggunakan
custom tag dan membuat custom DocLets.
Group 2 2

3. Javadoc comment ditulis oleh seorang programmer di
dalam java source code, yang nantinya akan diproses
oleh javadoc
Program akan mengubah javadoc comment dan
seluruh struktur program menjadi sebuah page HTML
sebagai dokumentasi dari program
Group 2 3

4. Saran untuk dokumentasi
Lebih sulit untuk maintenance software daripada
mengembangkannya
Maintenance akan jauh lebih muda jika program
memiliki dokumentasi yang baik
Kebanyakan programmer akan mendokumentasi
programnya setelah selesai. Ini adalah kesalahan
Group 2 4

5. Mendokumentasikan harus selesai secara bersama-
sama dengan coding.
Menunda-nunda pendokumentasian hingga
akhir, konsekuensinya dokumentasi tidak akan
maksimal
Group 2 5

6. Javadoc Syntax
/**
* ini adalah deskripsi dari part javadoc comment
*
* detail tambahan
*
* @tag1 content tag 1
* @tag2 content tag 2
*.
*.
*.
*/
Group 2 6

7. Kebanyakan Javadoc comments memiliki Javadoc tag
Javadoc tag diawali dengan simbol
“at”( @ ), kemudian diikuti oleh nama tag tersebut
Setiap tag mendeskripsikan sebuah attribut tertentu
yang dikomentari
Group 2 7

8. Javadoc Tag
o @author o @exception (or @throws)
o @version o @see
o @param o @since
o @return o @deprecated
Group 2 8

9. @author
@author author name
Untuk menentukan author dari class atau interface:
*
* @author Roy Sukro
* @author Ridho Zalphe
* @author Ramma Poenya
*
secara default tidak muncul dalam HTML yang
digenerate, kecuali diaktifkan terlebih dulu menggunakan
option -author ketika merunning javadoc
Group 2 9

10. @version
@version informasi versi
Menambahkan informasi versi di dalam sebuah class.
*
* @version 1.2
*
Hanya boleh 1 tag per class atau interface.
Secara default tidak muncul dalam HTML yang
digenerate, kecuali diaktifkan terlebih dulu
menggunakan option -author ketika merunning
javadoc
Group 2 10

11. @param
@param parameter-name description
Menambahkan informasi versi di dalam sebuah class.
/**
* mengembalikan hasil dari 2 integer
*
* @param a number which will be multiplied
* @param b multiplier number
* @return an int
*/
public int mul(int a, int b) {
return a*b;
}
Group 2 11

12. Group 2 12

13. @return
@return description of return value
Menjelaskan nilai return dari sebuah method
*
* @return A new BlahBlah Object with a field size of 100.
*
Group 2 13

14. Group 2 14

15. @exception
@exception class-name description
Menjelaskan exceptions yang dilempar oleh sebuah
constructor, method, class atau interface. Nama class
adalah nama dari exception tersebut.
/**
* Replaces test().
* @throws BlahException unless blah blah blah
* @exception BlahBlahException
*/
public test(int i) {
}
Group 2 15

16. Group 2 16

17. @see
@see nama_class
Menambah sebuah hyperlink yang menuju section
referenced oleh nama class yang disediakan
Group 2 17

18. /**
* Mengembalikan hasil kuadrat dari a dan b.
*
* @see #mul
*
* @param int operand one
* @param int operand two
* @return an int
*/
public int squaredMul(int a, int b) {
return mul(mul(a,a),mul(b,b));
}
Group 2 18

19. Group 2 19

20. @since
@since since-text
Menjelaskan versi berapa class atau method atau
interface tersebut yang telah ada.
*
* @since JDK1.4
*
Group 2 20

21. @deprecated
@deprecated deprecated-text
Menandai sebuah class, interface, atau method yang
tidak digunakan
Group 2 21

22. /**
* @deprecated Replaced by <code>test(int)</code>
* @see #test(int)
*/
public test() {
}
/**
* Replaces test().
*/
public test(int i) {
}
Group 2 22

23. Group 2 23

24. Setelah Javadoc comment selesai, gunaan javadoc
command untuk mengenerate program
dokumentasi.
Berikut merupakan ilustrasi dari syntax javadoc
comment.
Group 2 24

25. THANK YOU
VERY MUCH
Group 2 25