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