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

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

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

  • หลักเกณฑ์ API สำหรับ Jetpack Compose: ระบุรูปแบบ แนวทางปฏิบัติแนะนำ และหลักเกณฑ์ด้านรูปแบบที่บังคับใช้สำหรับระบบที่ใช้ปลั๊กอินคอมไพเลอร์และรันไทม์ของ Jetpack Compose ซึ่งประกอบด้วยหัวข้อต่อไปนี้
    • หลักเกณฑ์เกี่ยวกับรูปแบบ Kotlin สำหรับ Compose โดยอิงตามรูปแบบการเขียนโค้ด Kotlin
    • คำแนะนำสำหรับ@Composableฟังก์ชันและ API ที่สร้างขึ้นจากความสามารถรันไทม์ของ Compose
    • หลักเกณฑ์สําหรับ API ที่ใช้และขยายชุดเครื่องมือ UI ของ Compose
    • รูปแบบการแก้ไข 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 คู่มือการมีส่วนร่วม