Dokka ve KDoc ile Androidinizi Belgeleyin | yazan Enes Varol | Tem, 2022

Dokka ve KDoc ile Androidinizi Belgeleyin |  yazan Enes Varol |  Tem, 2022

Hepimiz “İyi kodun kendisini belgelediğini” biliyoruz, ancak kodunuzu belgelemek kimsenin (özellikle Vegita’nın) gururunu incitmez.

fotoğrafı çeken Jeet Dhanoa üzerinde Sıçramayı kaldır

Kotlin kodu için dokümantasyon yazmak için aşağıdaki eklentiyi kullanabiliriz:

Eklenti ile aşağıdaki gibi Kdoc’ları otomatik olarak oluşturabiliriz:

/**
* Image view show image from url
*
*
@param imageUrl url of the image
*/

Kdoc ile işimiz bittiğinde, ne yaptığımızı göstermenin zamanı geldi ve bunun için Dokka’ya ihtiyacımız var.

Dokka’yı projemize eklemeliyiz

1- Proje düzeyinde Gradle dosyasında

dependencies {
classpath "org.jetbrains.dokka:dokka-gradle-plugin:1.6.0"
}

2- Her modülde belgelemek istediğimiz Gradle

apply plugin: "org.jetbrains.dokka"

Not:

Emin olun:

1- Gradle’ınız, android stüdyonuz ve projeniz Java 11’i kullanıyor (./gradlew – version ile terminale göre kontrol edin)

2- Dokka eklentisi “com.android.application” ve “org.jetbrains.kotlin.android” sonrasında uygulanmalıdır.

Senkronizasyon ve yeniden oluşturma işleminden sonra (önbelleği de geçersiz kılabileceğimizden emin olmak için ancak isteğe bağlıdır) terminalde aşağıdaki satırlardan birini arayacağız:

1- ./gradlew dokkaHtml dokkaHtmlMultiModule (çoklu modül için)

2- ./gradlew dokkaHtml dokkaHtml (tek modül için)

Dokka bittiğinde, index.html’yi tarayıcıdan açabilirsiniz ve iyi yazılmış belgeler önünüzdedir.

1- Raywanderlich

2- Ahmetburakilhan’ın yazısı

3- Dokka

Özel Teşekkürlerimle İsmail Oğuzhan Ay

Bir cevap yazın

E-posta hesabınız yayımlanmayacak.