หลักเกณฑ์เกี่ยวกับรูปแบบสำหรับ API ของ Jetpack Compose

หากคุณกำลังเขียนโค้ด Compose สำหรับแอปหรือสร้างไลบรารีและ API ของ Compose ให้ทำตามแนวทางปฏิบัติแนะนำเพื่อให้โค้ดปรับขนาดได้ มีประสิทธิภาพมากขึ้น และสอดคล้องกับส่วนที่เหลือของระบบนิเวศ

เอกสารต่อไปนี้แสดงหลักเกณฑ์สำหรับผู้ที่เขียนโค้ดที่ใช้ Compose

• หลักเกณฑ์ API สำหรับ Jetpack Compose: สรุปรูปแบบ แนวทางปฏิบัติแนะนำ และหลักเกณฑ์ด้านสไตล์ที่กำหนดไว้สำหรับระบบที่ใช้ปลั๊กอินคอมไพเลอร์และรันไทม์ของ Jetpack Compose โดยมีหัวข้อดังต่อไปนี้
  • หลักเกณฑ์ด้านรูปแบบ Kotlin สำหรับ Compose โดยอิงตามรูปแบบการเขียนโค้ด Kotlin
  • คำแนะนำสำหรับฟังก์ชันและ API ของ @Composable ที่สร้างขึ้นจากความสามารถของรันไทม์ Compose
  • หลักเกณฑ์สำหรับ API ที่ใช้และขยายชุดเครื่องมือ Compose UI
  • รูปแบบสำหรับการจัดการ Use Case เมื่อออกแบบ Compose API
• หลักเกณฑ์ API สำหรับคอมโพเนนต์ @Composable ใน Jetpack Compose: แสดงชุดหลักเกณฑ์และคำแนะนำสำหรับการสร้างและใช้คอมโพเนนต์ UI ของ @Composable ซึ่งรวมถึงหัวข้อต่อไปนี้
  • การสร้างและจัดเลเยอร์คอมโพเนนต์
  • การตั้งชื่อคอมโพเนนต์ใหม่
  • การแสดงทรัพยากร Dependency ของคอมโพเนนต์
  • พารามิเตอร์ในคอมโพเนนต์ @Composable รายการ
  • ทำตามรูปแบบที่ถูกต้องสำหรับการสร้างคลาสและฟังก์ชันที่เกี่ยวข้องกับคอมโพเนนต์
  • กำลังจัดทำเอกสารคอมโพเนนต์ @Composable รายการ
  • การปรับปรุงการช่วยเหลือพิเศษสำหรับคอมโพเนนต์
  • การอัปเดต API ของคอมโพเนนต์ขณะที่ยังคงความเข้ากันได้แบบย้อนหลัง

กลุ่มเป้าหมาย

หลักเกณฑ์เหล่านี้เขียนขึ้นสำหรับกลุ่มเป้าหมาย 3 กลุ่มต่อไปนี้

• นักพัฒนาแอปที่สร้างแอปโดยใช้ Jetpack Compose คุณอยู่ในกลุ่มนี้หากใช้ Jetpack Compose ในบางส่วนของแอป
• นักพัฒนาซอฟต์แวร์ที่ทำงานเกี่ยวกับการพัฒนาเฟรมเวิร์ก Jetpack Compose คุณจะอยู่ในกลุ่มนี้หากมีส่วนร่วมในไลบรารี androidx.compose
• นักพัฒนาแอปที่สร้างไลบรารีโดยอิงตาม Jetpack Compose คุณจะอยู่ในกลุ่มนี้หากสร้าง Compose API หรือคลังองค์ประกอบ UI ของ Compose ไลบรารีของคอมโพเนนต์ Compose เหล่านี้อาจเผยแพร่ต่อสาธารณะหรือใช้ภายในบริษัทหรือทีมของคุณ

คุณจะมีระดับความเข้มงวดที่แตกต่างกันสำหรับหลักเกณฑ์ด้านรูปแบบแต่ละข้อ ทั้งนี้ขึ้นอยู่กับกลุ่มที่คุณอยู่ ตัวอย่างเช่น การพัฒนาเฟรมเวิร์ก Jetpack Compose โดยทั่วไปจะยึดตามหลักเกณฑ์เหล่านี้อย่างเคร่งครัดที่สุด

ดูข้อมูลเพิ่มเติมเกี่ยวกับข้อกำหนดสำหรับกลุ่มเป้าหมายนักพัฒนาแอปแต่ละกลุ่มได้ที่ RFC2119

มีส่วนร่วมในเฟรมเวิร์กและหลักเกณฑ์

เรายินดีรับการมีส่วนร่วมในไลบรารีบางรายการในฐานของโค้ด androidx และหลักเกณฑ์การจัดรูปแบบ (หลักเกณฑ์ Compose API และหลักเกณฑ์คอมโพเนนต์ @Composable)

หากต้องการร่วมให้ข้อมูล โปรดทำตามวิธีการในคู่มือการร่วมให้ข้อมูลของ androidx