תקני קידוד עבור וורדפרס [מדריך]

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

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

הצורך בלכידות ב WordPress הוא מוגדל על ידי המדינה שבה codebase הוא. וורדפרס אינו פועל לפי גישה קפדנית מונחה עצמים ואינו משתמש בתבנית MVC. פרויקטים אשר עוקבים אחר הנחיות OOP ו- MVC ללא יוצא מן הכלל (כמו Larevel) יש עקביות ושיטות עבודה מומלצות “אפוי” בשל המבנה שלהם.

וורדפרס למרבה הצער בשלים ספגטי קידוד, aka עושה מה שאתה רוצה. שיטות עבודה מומלצות קשה לאכוף פשוט כי מוצרים המעסיקים קוד רע יכול לעבוד בדיוק כמו גם (על פני השטח).

על ידי ביצוע וורדפרס קידוד תקני אתה יכול ללמוד קצת על אתוס קידוד של וורדפרס, ליצור יותר מוצרים תואמים וורדפרס. להראות את הקהילה שאכפת לך ואתה wrangle קוד איכותי.

עוד על Hongkiat.com:

• 10 סיוטים גרועים עבור מפתחי אינטרנט
• 5 סיבות מדוע CSS יכול להיות הכי קשה שפה של כל
• 30 תגובות נפוצות מתכנתים יש כאשר דברים משתבשים

כמה הערות על התקנים

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

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

עקביות על retentiveness אנאלי. אם אתה נמצא ב -10% האחרונים של הפרויקט שלך ואתה גילית שזה עתה השתמשת במוסמך למתן שמות שגוי לשיעורים, אל תעבור באמצע הדרך. לדעתי האישית, אני מעדיף לקרוא משהו שגוי באופן עקבי מאשר משהו שנכון לפעמים ולפעמים לא. אתה תמיד יכול לכתוב סקריפט לשנות דברים בבת אחת, או לקרוא את הקוד שלך בסוף.

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

תקני קידוד וורדפרס

כרגע וורדפרס יש ארבעה מדריכים, אחד עבור כל שפה גדולה בשימוש: PHP, HTML, Javascript ו- CSS. הם מהווים חלק מגוף ידע גדול יותר, מדריך התורמים הראשי. עובר הכל ייקח קצת זמן אז הדגשתי כמה קטעי מתוך ארבע שפות אשר לעתים קרובות אני רואה אנשים משתבשים.

PHP

PHP היא השפה העיקרית של וורדפרס והיא שפת די רופף למדי אשר מה שהופך אותו בשל רגולציה.

סגנונות

פלטה המוצא צריך תמיד להיות ממוקם בסוף השורות. יש להציב את ההצהרות המתייחסות לאותו קו כמו סוגר הסגירה הקודם. זה מודגם בצורה הטובה ביותר עם קוד לדוגמה:

אם (מצב) // האם משהו elseif (מצב) // האם משהו אחר // האם משהו

שימוש בחלל נדיב

אני לא מעריץ של קוד מעוך (יש לי ראייה רעה) אז זה אחד אני אוהב במיוחד לאכוף. לשים רווחים אחרי פסיקים, ועל שני הצדדים של הגיוני, השוואה, מחרוזת ו מפעילי ההקצאה, לאחר אם, postier, ל, לכל אחד ו החלף הצהרות וכן הלאה.

קל יותר לומר היכן אין להוסיף רווחים! הזמנים היחידים שאתה לא צריך להוסיף רווחים הוא מתי הקלדה או התייחסות מערכים.

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

הפונקציה my_function ($ complete_array = null, $ key_1 = 4, $ key_2 = 'bar') if (null == $ complete_array) $ final_array = $ complete_array;  אחר $ key_1 = (מספר שלם) $ key_1; $ final_array [0] = '|'; $ final_array [$ key_1] = 'is'; $ final_array [$ key_2] = 'a'; $ final_array ['last'] = 'example';  return $ final_array; 

מוסכמות למתן שמות

זה יכול להיות קשה להתרגל, במיוחד אם אתה בא מסביבות שונות. בקצרה:

• שמות משתנים צריך להיות כל מקרה נמוך, מילים מופרדות בקווים תחתונים
• שמות מחלקה צריך להשתמש מילים מהוונות מופרדים בקווים תחתונים. ראשי תיבות צריך להיות הכל באותיות רישיות
• קבועים צריך להיות כל באותיות רישיות, ספיראטד
• שמות קבצים צריך להיות כל מקרה נמוך, מפריד עם מקפים

תנאי יודה

תנאי כתיבה בכיוון ההפוך יותר מאשר אתה רגיל ימנע שגיאות ניתוח. זה נראה קצת מוזר אבל זה קוד טוב יותר.

אם ('דניאל' = $ $ שם) הד 'כתוב מאמר אתה'; 

HTML

HTML אין כללים רבים הקשורים אליו, אני יכול לבוא עם די הרבה לעשות דברים יותר מודולרי. יש רק חמישה כללים שעליך לדעת בעת כתיבת HTML:

1. על הקוד שלך להיות מאומת כנגד מאמת W3C.
2. תגי HTML סגירה עצמית חייבים להיות בדיוק מקום אחד לפני הקו נטוי הקדמי (זהו אחד שאני אישית שונא, אבל זה מפרט W3C, לא רק וורדפרס חיית המחמד)
3. התכונות והתגים חייבים להיות כולם קטנים. היוצא מן הכלל היחיד הוא כאשר ערכי תכונה מיועדים למאכל אדם, ובמקרה זה יש להקליד אותם באופן טבעי.
4. כל המאפיינים חייבים להיות בעלי ערך ויש לצטט אותם (כתיבה לא נכון)
5. הזחה צריך להיות מושגת באמצעות כרטיסיות צריך לעקוב אחר המבנה הלוגי.

CSS

CSS הוא עוד שפה הקלדת רופף אז יש הרבה עבודה לעשות כאן גם כן. עם זאת, הסטנדרטים הולכים די קל על coders.

בוררים

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

קלט [type = "text"], קלט [type = "password"], .name-field background: # f1f1f1; 

הזמנת נכס

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

הסיבה הגדולה ביותר אקראיות היא “אה אני גם צריך להוסיף שולי” ולאחר מכן להמשיך ולהוסיף אותו לתחתית. קח את תוספת 0.3 שניות ולהוסיף את הכלל במקום ההגיוני.

• תצוגה
• מיקום
• מודל תיבה
• צבעים וטיפוגרפיה
• אחר

.פרופילמוד תפקיד מוחלט משמאל: 100px; top: 90px; רקע: # ff9900; צבע: #fff; 

עיצוב ערך

זה מקום אחד שבו אני שונא במיוחד לראות חוסר עקביות. אם אתה לא פעל לפי ההנחיות, זה עדיין טוב יותר מאשר לפעמים לראות רווח לפני הערך; לפעמים באמצעות קצרנות, לפעמים לא; לפעמים באמצעות יחידות על 0 ערכים, לפעמים לא, וכו '.

עיצוב ערך הוא די מורכב אבל זה בא באופן טבעי עם קצת תרגול. תסתכל על המדריך המדויק של קודקס לעיצוב הערכים שלך.

Javascript

מניסיוני Javascript הוא נוטה ביותר ללכת בכל מקום. בעוד מפתחים רבים יודעים כמות ניכרת של Javascript הוא למד בהדרגה, כמו מחשבה נוספת HTML, CSS ו- PHP. כאשר אתה רק מתחיל עם שפה חדשה אתה עושה הרבה יותר טעויות ואם שגיאות אלה לא לגרום לשגיאות קטלניות, הם יכולים להיות מוטבע בך.

במקרים רבים התקנים מתייחסים למגבלת קו או למדינה “אם שורה אינה ארוכה מדי”. זה מתייחס מדריך סגנון jQuery אשר מטיל מגבלת 100 תווים על השורות. המדריך וורדפרס מבוסס על המדריך jQuery, אז זה רעיון טוב לתת את זה לקרוא גם.

פסיקים

זהו הכלל הפשוט ביותר, אבל הוא אחד אשר לעתים קרובות התעלמו. לעולם, לעולם, להשמיט נקודה פסיק רק בגלל שהקוד שלך יעבוד בלי זה. זה פשוט מרושל.

הזחה

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

שוברים שורות

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

כמו כן, אם מצב הוא ארוך, לשבור אותו שורות מרובות ולהוסיף לשונית נוספת לפני זה. זה נראה מוזר מאוד בעיני אבל ההפרדה היא מוסיפה בין המצב לגוף גלוי מאוד.

אם (firstCondition () & & secondCondition () & & thirdCondition ()) var html = 'שורה זו מורכבת ממילים' + n + ', לכן יש לפרק אותה לאחר' + 'אופרטור'; 

jQuery איטרציה

על פי תקן jQuery סטנדרטים (jQuery.each ()) יש להשתמש רק על אובייקטים jQuery. אתה צריך להשתמש בסיסיים ל, ב, בזמן לולאות Javascript עבור iterating מעל אוספים אחרים.

סיכום

יש הרבה כדי לציין ולעקוב אחר ואין דרך שמישהו יכול ליישם את כל זה בבת אחת. אתה צריך לקחת את הקוד שלך קרוב ככל שתוכל על הסטנדרטים ולעבוד על אותם בדיוק.

לדעתי עקביות היא הכלל החשוב ביותר. עדיף בעקביות לעשות משהו לא נכון מאשר לעבור חצי הדרך. זה נכון במיוחד עם שיטות עיצוב שכן אלה אינם משפיעים על הפונקציונליות של הקוד שלך - על פי רוב - ניתן לשנות אצווה בקלות מאוחר יותר.

האם אתה שונא אלמנט של תקני קידוד, אתה חושב משהו צריך להוסיף? תן לנו לדעת את ההערות!