הנחיות סגנון לממשקי API של Jetpack Compose

אם אתם כותבים קוד Compose לאפליקציה או יוצרים ספריות וממשקי API של Compose, כדאי לפעול לפי השיטות המומלצות כדי שהקוד יהיה ניתן להרחבה, יפעל בצורה יעילה יותר ויהיה עקבי עם שאר המערכת האקולוגית.

במסמכים הבאים מפורטות הנחיות לכל מי שכותב קוד שמשתמש ב-Compose:

• הנחיות ל-API ל-Jetpack פיתוח נייטיב: מפורטים בהן דפוסים, שיטות מומלצות והנחיות סגנון מחייבות לכל מערכת שמשתמשת בתוסף של מהדר Jetpack פיתוח נייטיב ובזמן ריצה. הנושאים שמופיעים בו:
  • הנחיות לסגנון ב-Kotlin ל-Compose, שמבוססות על מוסכמות התכנות ב-Kotlin
  • הנחיות לגבי פונקציות ו-API של @Composable שמבוססים על היכולות של זמן הריצה של Compose
  • הנחיות לשימוש בממשקי API שמרחיבים את ערכת הכלים לבניית ממשק משתמש ב-Compose
  • דפוסים לטיפול בתרחישי שימוש בתכנון של Compose API
• הנחיות ל-API לרכיבי @Composable ב-Jetpack Compose: מספקות קבוצה של הנחיות והמלצות ליצירה ולשימוש ברכיבי ממשק משתמש של @Composable, כולל הנושאים הבאים:
  • יצירה של רכיבים והוספה שלהם לשכבות
  • איך נותנים שם לרכיב חדש
  • הגדרת יחסי תלות בין רכיבים
  • פרמטרים ברכיבי @Composable
  • שימוש בתבניות נכונות ליצירת פונקציות וכיתות שקשורות לרכיבים
  • תיעוד של רכיבי @Composable
  • שיפור הנגישות של רכיבים
  • עדכון של ממשקי API של רכיבים תוך שמירה על תאימות לאחור

קהל

ההנחיות האלה מיועדות לשלושה קהלים:

• מפתחים שיוצרים אפליקציות שמבוססות על Jetpack פיתוח נייטיב. אתם נכללים בקבוצה הזו אם אתם משתמשים ב-Jetpack Compose בחלק כלשהו של האפליקציה.
• מפתחים שעובדים על פיתוח מסגרת Jetpack Compose. אתם נכללים בקבוצה הזו אם אתם תורמים לספריות של androidx.compose.
• מפתחים שיוצרים ספריות שמבוססות על Jetpack Compose. אתם בקבוצה הזו אם אתם יוצרים ממשקי API של Compose או ספריות של רכיבי ממשק משתמש של Compose. ספריות הרכיבים של Compose יכולות להיות זמינות לציבור או מקומיות לחברה או לצוות שלכם.

בהתאם לקבוצה שבה אתם נמצאים, יש רמות שונות של הקפדה על כל הנחיות הסגנון. לדוגמה, פיתוח של מסגרת Jetpack Compose בדרך כלל מבוסס על ההנחיות האלה באופן הכי קפדני.

מידע נוסף על הדרישות לכל קהל מפתחים זמין בRFC2119.

תרומה למסגרת ולהנחיות

נשמח לקבל תרומות לספריות נבחרות בבסיס הקוד androidx ולהנחיות הסגנון (הנחיות ל-Compose API והנחיות לרכיבי @Composable).

כדי לתרום, פועלים לפי ההוראות androidx במדריך לתורמים.