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