Jetpack Compose API'leri için stil kuralları

Uygulamanız için Compose kodu yazıyorsanız veya Compose kitaplıkları ve API'leri oluşturuyorsanız kodunuzu ölçeklenebilir, daha performanslı ve ekosistemin geri kalanıyla tutarlı hale getirmek için en iyi uygulamaları izleyin.

Aşağıdaki belgelerde, Compose kullanan kod yazan herkes için yönergeler verilmiştir:

  • Jetpack Compose için API Kuralları: Jetpack Compose derleyici eklentisini ve çalışma zamanını kullanan tüm sistemler için kalıpları, en iyi uygulamaları ve kuralcı stil kurallarını özetler. Aşağıdaki konuları içerir:
    • Kotlin Kodlama Kuralları'na dayalı olarak Compose için Kotlin stil yönergeleri
    • Compose çalışma zamanı özelliklerini temel alan @Composable işlevleri ve API'leri için kılavuz
    • Compose kullanıcı arayüzü araç setini kullanan ve genişleten API'ler için yönergeler
    • Compose API tasarlarken kullanım alanlarını ele alma kalıpları
  • Jetpack Compose'da @Composable bileşenleri için API yönergeleri: @Composable kullanıcı arayüzü bileşenleri oluşturma ve kullanma ile ilgili yönergeler ve öneriler sunar. Bu yönergeler ve öneriler aşağıdaki konuları içerir:
    • Bileşen oluşturma ve katmanlama
    • Yeni bir bileşeni adlandırma
    • Bileşen bağımlılıklarını ifade etme
    • @Composable bileşenlerindeki parametreler
    • Bileşenle ilgili sınıflar ve işlevler oluşturmak için doğru kalıpları kullanma
    • @Composable bileşen belgeleniyor
    • Bileşenlerin erişilebilirliğini iyileştirme
    • Geriye dönük uyumluluğu korurken 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 geliştiren geliştiriciler. Uygulamanızın bir bölümünde Jetpack Compose kullanıyorsanız bu gruptasınız demektir.
  • Jetpack Compose çerçevesi üzerinde çalışan geliştiriciler. androidx.compose kitaplıklarına katkıda bulunuyorsanız bu grupta yer alırsınız.
  • Jetpack Compose'u temel alan kitaplıklar oluşturan geliştiriciler. Compose API'leri veya Compose kullanıcı arayüzü öğelerinin kitaplıklarını oluşturuyorsanız bu gruptasınız demektir. Bu Compose bileşen kitaplıkları herkese açık olabilir veya şirketiniz ya da ekibiniz tarafından kullanılabilir.

Bulunduğunuz gruba bağlı olarak, her stil kuralı için farklı katılık seviyeleriniz vardır. Örneğin, Jetpack Compose çerçeve geliştirme genellikle bu yönergelere en sıkı şekilde uyar.

Her geliştirici kitlesi için geçerli şartlar hakkında daha fazla bilgi edinmek istiyorsanız RFC2119'a göz atın.

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

androidx kod tabanındaki belirli kitaplıklara ve stil yönergelerine (Compose API yönergeleri ve @Composable bileşen yönergeleri) katkıda bulunabilirsiniz.

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