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

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

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

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

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

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

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

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

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