अगर आपको अपने ऐप्लिकेशन के लिए Compose कोड लिखना है या Compose लाइब्रेरी और एपीआई बनाना है, तो सबसे सही तरीकों का पालन करें. इससे आपका कोड स्केलेबल और बेहतर परफ़ॉर्म करेगा. साथ ही, यह बाकी के पारिस्थितिक तंत्र के साथ काम करेगा.
नीचे दिए गए दस्तावेज़ उन सभी लोगों के लिए दिशा-निर्देश देते हैं जो 'लिखें' सुविधा का इस्तेमाल करके कोड बनाते हैं:
- Jetpack Compose के लिए एपीआई के दिशा-निर्देश: इनमें पैटर्न, सबसे सही तरीके, और निर्देशों के स्टाइल के दिशा-निर्देश शामिल हैं. ये दिशा-निर्देश, Jetpack Compose कंपाइलर प्लग इन और रनटाइम का इस्तेमाल करने वाले किसी भी सिस्टम के लिए हैं. इसमें ये विषय शामिल हैं:
- Compose के लिए Kotlin स्टाइल से जुड़े दिशा-निर्देश. ये दिशा-निर्देश Kotlin Codingकन्वर्ज़न पर आधारित हैं
- Compose के रनटाइम की सुविधाओं पर आधारित
@Composableफ़ंक्शन और एपीआई के लिए दिशा-निर्देश - Compose यूज़र इंटरफ़ेस (यूआई) टूलकिट का इस्तेमाल करने और उसे बेहतर बनाने वाले एपीआई के लिए दिशा-निर्देश
- Compose API डिज़ाइन करते समय, इस्तेमाल के उदाहरणों को हल करने के लिए पैटर्न
- Jetpack Compose में
@Composableकॉम्पोनेंट के लिए एपीआई के दिशा-निर्देश:@Composableयूज़र इंटरफ़ेस (यूआई) कॉम्पोनेंट बनाने और इस्तेमाल करने के लिए, दिशा-निर्देशों और सुझावों का एक सेट उपलब्ध कराता है. इसमें ये विषय शामिल हैं:- कॉम्पोनेंट बनाना और लेयर करना
- एक नए कॉम्पोनेंट को नाम देना
- कॉम्पोनेंट डिपेंडेंसी को एक्सप्रेस करना
@Composableकॉम्पोनेंट में पैरामीटर- कॉम्पोनेंट से जुड़ी क्लास और फ़ंक्शन बनाने के लिए सही पैटर्न का इस्तेमाल करना
@Composableकॉम्पोनेंट का दस्तावेज़ बनाना- कॉम्पोनेंट के लिए सुलभता को बेहतर बनाना
- पुराने सिस्टम के साथ काम करने की सुविधा को बनाए रखते हुए, कॉम्पोनेंट एपीआई अपडेट करना
ऑडियंस
ये दिशा-निर्देश, इन तीन ऑडियंस के लिए हैं:
- Jetpack Compose के आधार पर ऐप्लिकेशन बनाने वाले डेवलपर. अगर आपने अपने ऐप्लिकेशन के किसी हिस्से में Jetpack Compose का इस्तेमाल किया है, तो आप इस ग्रुप में शामिल हैं.
- Jetpack Compose फ़्रेमवर्क के डेवलपमेंट पर काम करने वाले डेवलपर. अगर आप
androidx.composeलाइब्रेरी में योगदान देते हैं, तो आप इस ग्रुप में हैं. - Jetpack Compose के आधार पर लाइब्रेरी बनाने वाले डेवलपर. अगर आपने Compose के एपीआई या यूज़र इंटरफ़ेस (यूआई) एलिमेंट की लाइब्रेरी बनाई है, तो आप इस ग्रुप में शामिल हैं. Compose कॉम्पोनेंट की ये लाइब्रेरी, सार्वजनिक तौर पर उपलब्ध हो सकती हैं या आपकी कंपनी या टीम के लिए स्थानीय तौर पर उपलब्ध हो सकती हैं.
आप जिस ग्रुप में हैं उसके हिसाब से, हर स्टाइल के दिशा-निर्देश के लिए, ज़रूरी शर्तों के लेवल अलग-अलग होते हैं. उदाहरण के लिए, Jetpack Compose का फ़्रेमवर्क डेवलपमेंट आम तौर पर इन दिशा-निर्देशों का पालन करता है.
हर डेवलपर ऑडियंस की ज़रूरी शर्तों के बारे में ज़्यादा जानने के लिए, RFC2119 देखें.
फ़्रेमवर्क और दिशा-निर्देशों में योगदान देना
हम androidx कोडबेस और स्टाइल से जुड़ी गाइडलाइन (Compose API के लिए गाइडलाइन और
@Composable कॉम्पोनेंट के लिए गाइडलाइन) में मौजूद चुनिंदा लाइब्रेरी में योगदान देने के लिए आपका स्वागत करते हैं.
योगदान देने के लिए, androidx योगदान देने के लिए बनी गाइड में दिए गए निर्देशों का पालन करें.