Jetpack Compose API'leri için stil kuralları

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

Aşağıdaki dokümanlarda, Compose'u kullanan kod yazan herkes için yönergeler verilmiştir:

  • Jetpack Compose için API Yönergeleri: Jetpack Compose derleyici eklentisini ve çalışma zamanını kullanan tüm sistemler için kalıpları, en iyi uygulamaları ve zorunlu stil yönergelerini özetler. Bu dokümanda aşağıdaki konular ele alınmıştır:
    • 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 yol gösterici bilgiler
    • 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'daki @Composable bileşenleri için API yönergeleri: Aşağıdaki konular da dahil olmak üzere @Composable kullanıcı arayüzü bileşenlerini oluşturma ve kullanmayla ilgili bir dizi yönerge ve öneri sağlar:
    • Bileşen oluşturma ve katmanlama
    • Yeni bileşene ad verme
    • Bileşen bağımlılıklarını ifade etme
    • @Composable bileşenlerindeki parametreler
    • Bileşenle ilgili sınıf ve işlevler oluşturmak için doğru kalıpları takip etme
    • @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 hazırlanmış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çeve geliştirmesi üzerinde çalışan geliştiriciler. androidx.compose kitaplıklarına katkıda bulunuyorsanız bu gruptasınız demektir.
  • Jetpack Compose'a dayalı 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 veya şirketinize ya da ekibinize özel olabilir.

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

Her geliştirici kitlesi için geçerli şartlar hakkında daha fazla bilgi edinmek isterseniz RFC2119'a bakın.

Çerçeveye ve kurallara 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 bulunmanızı bekliyoruz.

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