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