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