Kodlama yaparken yazdığımız metotlara yaptığı işe uygun isimler vermeye çalışırız. Fakat bazı durumlarda isimle ne yapmak istediğimizi anlatamayabiliriz. Bu durumlarda daha fazla bilgi vermemize yarayan javadoc yardımcısını kullanabiliriz.
javadoc, /** yorum */ taglarını kullanır. @ işaretiyle başlayan anahtar sözcükler kullanılır. Önemli birkaç etiket ve niçin kullanıldığı aşağıda ki tabloda gösterilmiştir.
|
geliştirici, yazar | |
| @param | metodun aldığı parametreler ve tipleri | |
| @return | dönüş tipi | |
| {@code} | örnek kullanım | |
| @see | ilişkili belgelenmiş(javadoc u yazılmış) kod |
Android studio da ise bu bölümü oluşturmak için metodla aynı satırda iken imleci satır başına getirip /** ni yazıp ENTER tuşuna basıyoruz.
/** + ENTER
örnek bir javadoc
