pengenalan javadoc

JavaDocBy Group 2

Group 2 2

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.

Apa itu JavaDoc?

Group 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 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 5

Mendokumentasikan harus selesai secara bersama-sama dengan coding.

Menunda-nunda pendokumentasian hingga akhir, konsekuensinya dokumentasi tidak akan maksimal

Group 2 6

Javadoc Syntax

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

Group 2 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 8

o @author o @versiono @param o @return

o @exception (or @throws)o @seeo @sinceo @deprecated

Javadoc Tag

Group 2 9

@author author nameUntuk 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

@author

Group 2 10

@version informasi versiMenambahkan 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

@version

Group 2 11

@param parameter-name descriptionMenambahkan 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; }

@param

Group 2 12

Group 2 13

@return description of return valueMenjelaskan nilai return dari sebuah method * * @return A new BlahBlah Object with a field size of 100. *

@return

Group 2 14

Group 2 15

@exception class-name descriptionMenjelaskan 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) { }

@exception

Group 2 16

Group 2 17

@see nama_classMenambah sebuah hyperlink yang menuju section referenced oleh nama class yang disediakan

@see

Group 2 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 19

Group 2 20

@since since-text Menjelaskan versi berapa class atau method

atau interface tersebut yang telah ada. * * @since JDK1.4 *

@since

Group 2 21

@deprecated deprecated-text Menandai sebuah class, interface, atau

method yang tidak digunakan

@deprecated

Group 2 22

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

Group 2 23

Group 2 24

Setelah Javadoc comment selesai, gunaan javadoc command untuk mengenerate program dokumentasi.

Berikut merupakan ilustrasi dari syntax javadoc comment.

Group 2 25

THANK YOUVERY MUCH