Jetpack Compose API'leri için stil kuralları

Uygulamanız için Compose kodu yazıyor veya Compose kitaplıkları ve API'ler oluşturuyorsanız kodunuzu ekosistemin geri kalanıyla tutarlı, ölçeklenebilir, performanslı ve tutarlı hale getirmek için en iyi uygulamalardan yararlanın.

Aşağıdaki dokümanlarda, Oluşturma kullanan kod yazan herkes için yönergeler verilmektedir:

  • Jetpack Compose için API Yönergeleri: Jetpack Compose derleyici eklentisini ve çalışma zamanını kullanarak herhangi bir sistem için kalıpları, en iyi uygulamaları ve kuralcı stil kurallarını özetler. Belgede şu konular ele alınmaktadır:
    • Kotlin Kodlama Kuralları'na dayanan, Compose için Kotlin stili kuralları
    • Compose çalışma zamanı özelliklerini temel alan @Composable işlevleri ve API'ler için rehberlik
    • Compose kullanıcı arayüzü araç setini kullanan ve genişleten API'lerle ilgili yönergeler
    • Compose API'si tasarlarken kullanım alanlarını ele alma kalıpları
  • Jetpack Compose'daki @Composable bileşenleri için API Yönergeleri: @Composable kullanıcı arayüzü bileşenlerini oluşturma ve kullanmayla ilgili aşağıdaki konular dahil olmak üzere bir dizi yönerge ve öneri sağlar:
    • Bileşenleri oluşturma ve katmanlama
    • Yeni bir bileşeni adlandırma
    • Bileşen bağımlılıklarını ifade etme
    • @Composable bileşendeki parametreler
    • Bileşenlerle ilgili sınıflar ve işlevler oluşturmak için doğru kalıpları izlemek,
    • @Composable bileşeni belgeleme
    • Bileşenler için erişilebilirliği iyileştirme
    • Geriye dönük uyumluluğu koruyarak bileşen API'lerini güncelleme

Kitle

Bu yönergeler aşağıdaki üç kitle için yazılmıştır:

  • Jetpack Compose'a dayalı uygulamalar oluşturan geliştiriciler. Uygulamanızın bir bölümünde Jetpack Compose'u kullanıyorsanız bu grupta yer alırsınız.
  • Jetpack Compose çerçevesi geliştirme üzerinde çalışan geliştiriciler. androidx.compose kitaplıklarına katkıda bulunursanız bu grupta olursunuz.
  • Jetpack Compose'a dayalı kitaplık oluşturan geliştiriciler. Compose API'leri veya Compose kullanıcı arayüzü öğelerinden oluşan kitaplıklar oluşturursanız bu grupta olursunuz. Compose bileşenlerinin bu kitaplıkları herkese açık veya şirketiniz ya da ekibiniz için yerel olabilir.

Dahil olduğunuz gruba bağlı olarak, her stil yönergesi için farklı güvenlik düzeyi seviyeleriniz vardır. Örneğin, Jetpack Compose çerçeve geliştirme sürecinde genelde en katı şekilde bu yönergelere uyulur.

Her bir geliştirici kitlesiyle ilgili gereksinimler hakkında daha fazla bilgi için RFC2119 bölümüne bakın.

Çerçeveye ve yönergelere katkıda bulunma

androidx kod tabanındaki belirli kitaplıklara ve stil kurallarına (Oluşturma API'si yönergeleri ve @Composable bileşenleri yönergeleri) katkıda bulunmaktan memnuniyet duyarız.

Katkıda bulunmak için androidx katkı rehberindeki talimatları uygulayın.