หากคุณเขียนโค้ด Compose สำหรับแอปหรือสร้างไลบรารีและ API ของ Compose ให้ทำตามแนวทางปฏิบัติแนะนำเพื่อให้โค้ดปรับขนาดได้ มีประสิทธิภาพมากขึ้น และสอดคล้องกับระบบนิเวศอื่นๆ
เอกสารต่อไปนี้มีหลักเกณฑ์สำหรับทุกคนที่เขียนโค้ดที่ใช้ Compose
- หลักเกณฑ์ API สำหรับ Jetpack Compose: สรุปรูปแบบ แนวทางปฏิบัติแนะนำ และหลักเกณฑ์ด้านสไตล์ที่กำหนดไว้สำหรับทุกระบบที่ใช้ปลั๊กอินคอมไพเลอร์และรันไทม์ของ Jetpack Compose ซึ่งรวมถึงหัวข้อต่อไปนี้
- หลักเกณฑ์ด้านสไตล์ของ Kotlin สำหรับ Compose ซึ่งอิงตามข้อกำหนดการเขียนโค้ด ของ Kotlin
- คำแนะนำสำหรับฟังก์ชันและ API ของ
@Composableที่สร้างขึ้นจากความสามารถของรันไทม์ของ Compose - หลักเกณฑ์สำหรับ API ที่ใช้และขยายชุดเครื่องมือ UI ของ Compose
- รูปแบบสำหรับการจัดการ Use Case เมื่อออกแบบ API ของ Compose
- หลักเกณฑ์ API สำหรับคอมโพเนนต์
@Composableใน Jetpack Compose: ให้ชุดหลักเกณฑ์และคำแนะนำสำหรับการสร้างและใช้ คอมโพเนนต์ UI@Composableซึ่งรวมถึงหัวข้อต่อไปนี้:- การสร้างและจัดเลเยอร์คอมโพเนนต์
- การตั้งชื่อคอมโพเนนต์ใหม่
- การแสดงทรัพยากร Dependency ของคอมโพเนนต์
- พารามิเตอร์ในคอมโพเนนต์
@Composable - การทำตามรูปแบบที่ถูกต้องสำหรับการสร้างคลาสและฟังก์ชันที่เกี่ยวข้องกับคอมโพเนนต์
- การจัดทำเอกสารคอมโพเนนต์
@Composable - การปรับปรุงการช่วยเหลือพิเศษสำหรับคอมโพเนนต์
- การอัปเดต API ของคอมโพเนนต์โดยยังคงความเข้ากันได้แบบย้อนหลัง
กลุ่มเป้าหมาย
หลักเกณฑ์เหล่านี้เขียนขึ้นสำหรับกลุ่มเป้าหมาย 3 กลุ่มต่อไปนี้
- นักพัฒนาแอปที่สร้างแอปโดยอิงตาม Jetpack Compose คุณอยู่ในกลุ่มนี้หากใช้ Jetpack Compose ในบางส่วนของแอป
- นักพัฒนาแอปที่ทำงานเกี่ยวกับการพัฒนาเฟรมเวิร์ก Jetpack Compose คุณอยู่ในกลุ่มนี้หากมีส่วนร่วมในไลบรารี
androidx.compose - นักพัฒนาแอปที่สร้างไลบรารีโดยอิงตาม Jetpack Compose คุณอยู่ในกลุ่มนี้หากสร้าง API ของ Compose หรือไลบรารีขององค์ประกอบ UI ของ Compose ไลบรารีคอมโพเนนต์ของ Compose เหล่านี้อาจเผยแพร่ต่อสาธารณะหรือใช้ได้เฉพาะในบริษัทหรือทีมของคุณ
คุณจะมีระดับความเข้มงวดที่แตกต่างกันสำหรับหลักเกณฑ์ด้านสไตล์แต่ละข้อ ทั้งนี้ขึ้นอยู่กับกลุ่มที่คุณอยู่ ตัวอย่างเช่น การพัฒนาเฟรมเวิร์ก Jetpack Compose โดยทั่วไปจะยึดตามหลักเกณฑ์เหล่านี้อย่างเคร่งครัดที่สุด
ดูข้อมูลเพิ่มเติมเกี่ยวกับข้อกำหนดสำหรับกลุ่มเป้าหมายนักพัฒนาแอปแต่ละกลุ่มได้ที่ RFC2119
มีส่วนร่วมในเฟรมเวิร์กและหลักเกณฑ์
เรายินดีรับการมีส่วนร่วมในไลบรารีที่เลือกในฐานของโค้ด androidx และหลักเกณฑ์ด้านสไตล์ (หลักเกณฑ์ API ของ Compose และ
@Composable หลักเกณฑ์คอมโพเนนต์) เอง
หากต้องการมีส่วนร่วม ให้ทำตามวิธีการใน androidx การมีส่วนร่วม
คู่มือ