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 kodunuzun ölçeklenebilir, daha iyi performanslı ve ekosistemin geri kalanıyla tutarlı olması için en iyi uygulamaları izleyin.

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

  • 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 rehberlik
    • Compose kullanıcı arayüzü araç setini kullanan ve genişleten API'lerle ilgili yönergeler
    • Compose API tasarlarken kullanım alanlarını ele alma kalıpları
  • Jetpack Compose'daki @Composable bileşenleri için API yönergeleri: Aşağıdaki konular da dahil olmak üzere @Composable kullanıcı arayüzü bileşenleri oluşturma ve kullanmayla ilgili bir dizi yönerge ve öneri sunar:
    • 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şenlerini belgeleme
    • 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ızdır.
  • Jetpack Compose çerçeve geliştirme üzerinde çalışan geliştiriciler. androidx.compose kitaplıklarına katkıda bulunuyorsanız bu gruptasınızdır.
  • Jetpack Compose'a dayalı kitaplıklar oluşturan geliştiriciler. Compose API'leri veya Compose kullanıcı arayüzü öğeleri kitaplıkları oluşturuyorsanız bu gruptasınızdır. Bu Compose bileşenleri kitaplıkları herkese açık olabilir veya şirketiniz ya da ekibiniz için yerel olabilir.

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

Her geliştirici kitlesiyle ilgili şartlar hakkında daha fazla bilgi için RFC2119'a bakın.

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

androidx kod tabanındaki belirli kitaplıklara ve stil kurallarına (Compose API kuralları ve @Composable bileşen kuralları) katkıda bulunabilirsiniz.

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