Javadoc

Tanım: Java'da sınıfların içine geliştiricilere yardımcı olması amacıyla girilen yorumlar. Yardım metinleri /** ile */ arasında girilmektedir. Bu yorumlardan javadoc komutu ile HTML üretilmektedir

---

Eclipse'de @author İfadesi Değiştirmek

Eclipse'da bir sınıfın üstüne java doc yorumu eklendiğinde yazar olarak @author ifadesi otomatik eklenmektedir. Eclipse işletim sisteminde user ne görülüyorsa o ifadeyi eklemektedir. Bu iki yolla değiştirilebilir :

• Eclipse çalıştırılırken -Duser.name="Ali Kaya" şeklinde çalıştırılabilir
  
• Window - Preferences - Java - Code Style - Code Templates - Comments - Types bölümünde ve Window - Preferences - Java - Editor - Templates - @author bölümünde istenildiği gibi düzenlenebilir.
  

---

Java Doc Yorumuna Kod Eklenmesi

Java'da kod eklenmesi için @code ve pre etiketi kullanılabilir. Örneğin aşağıda bir sınıfın üstünde kod örneği görülmektedir :

/**
 * Test yorum ...
 * 

 * kod aşağıdaki gibidir :
* 
{@code
 * Test service=new Test (1);
 * String a=service.get();
 * }
 * 
class A {
....
}

pre etiketi , aradaki kodun aynen aktarılmasını sağlamaktadır. @code ifadesi ise code elementini koyar ve < > gibi ifadelerin escape edilmesi sağlamaktadır. @code yerine @literal ifadesi de kullanılabilir

---

JavaDoc ile UTF-8 Desteği

Normal durumlarda javadoc komutu Türkçe karakterler için sorun çıkarır. Javadoc komutu çalıştırırken aşağıdaki parametreler verilerek UTF-8 destekler hale getirilebilir:

-encoding UTF-8 -charset UTF-8 -docencoding UTF-8

---

Eclipse ve Maven ile JavaDoc ve JavaDoc Jar Dosyasını Oluşturma

Eclipse'de bir Maven projesinde otomatik javadoc dosyalarının oluşturulması sağlanabilir.

Öncelikle javadoc üreten plugin pom.xml'e eklenmelidir :

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-javadoc-plugin</artifactId>
	<executions>
		<execution>
			<id>attach-javadocs</id>
			<goals>
				<goal>jar</goal>
			</goals>
		</execution>
	</executions>
</plugin>

Ardında eclipse üzerinde Run As -> Maven Install komutunu çalıştırırsanız jar , java-doc için ayrı bir jar ve javadoc dosyaları üretilmiş olacaktır.

Üretilen javadoc sayfalarında Türkçe karakter sorununu çözmek için pom.xml'de project elementi içine aşağıdaki gibi property'leri eklemeniz gerekir :

<properties>
	<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
	<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
</properties>

.

---

Eclipse ve Maven ile JavaDoc ve JavaDoc Jar Dosyasını Oluşturma

Eclipse'de bir Maven projesinde otomatik javadoc dosyalarının oluşturulması sağlanabilir.

Öncelikle javadoc üreten plugin pom.xml'e eklenmelidir :

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-javadoc-plugin</artifactId>
	<executions>
		<execution>
			<id>attach-javadocs</id>
			<goals>
				<goal>jar</goal>
			</goals>
		</execution>
	</executions>
</plugin>

Ardında eclipse üzerinde Run As -> Maven Install komutunu çalıştırırsanız jar , java-doc için ayrı bir jar ve javadoc dosyaları üretilmiş olacaktır.

Üretilen javadoc sayfalarında Türkçe karakter sorununu çözmek için pom.xml'de project elementi içine aşağıdaki gibi property'leri eklemeniz gerekir :

<properties>
	<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
	<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
</properties>

.

---