דף הבית » קידוד » למה אתה צריך קוד sniffers עבור פיתוח אינטרנט

    למה אתה צריך קוד sniffers עבור פיתוח אינטרנט

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

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

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

    מה קוד מרחרח?

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

    מרחרח קוד דומה קוד linting אבל פדנטי יותר. משחה בעיקר בודק באגים שגיאות תחביר בעוד מרחרח מחפש בעיות ב הדרך שבה נכתב הקוד. קובץ PHP עדיין יכול לתפקד כראוי אבל ייכשל בדיקת קוד מרחרח אם שם משתנה אינו עומד בסטנדרטים (כלומר. $ myVariable לעומת $ my_variable).

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

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

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

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

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

    אם אתה בונה webapp קטן עבור עצמך זה לא יכול להיות שווה לבזבז זמן על WCAG 2.0 או PSR-2 סטנדרטים. אבל לשקול את מאות מפתחים עובדים על קוד המקור של Adobe Photoshop. זה יהיה כאוטי אם כל אדם כתב את הסגנון שלו ושילב הכל ביחד.

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

    תקני ערך של קוד

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

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

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

    הנה כמה תקני קידוד לשקול כי טווח של סולם של שפות אינטרנט שונות.

    • PEAR קידוד תקנים (PHP)
    • תקני Google עבור HTML / CSS
    • תקנים של
    • סגנון קידוד ג'נגו (Python)
    • רכבות סגנון מדריך (רובי)
    • WCAG 2.0 (UX)

    קוד הטוב ביותר מרחרח משאבים

    עכשיו אפשר למצוא חינם קוד sniffers עבור כל דבר, החל HTML / CSS כדי backend שפות כמו PHP ו- SQL. ייתכן שלא תצטרך להשתמש במריחנים אלה או בצע סטנדרטים עבור כל שפה, אך כדאי לבדוק את האפשרויות כדי לראות מה עשוי לשפר את הביצועים שלך.

    קוד קדמי sniffers

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

    זה המריח בודק נגד שלוש רמות של WCAG של A, AA, ו AAA תקני נגישות יחד עם סעיף 508 הנחיות החלים בעיקר על אתרי הממשלה.

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

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

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

    עבור הרשומה ניתן גם לבדוק סטנדרטים JS / CSS ישירות עם PHP_CodeSniffer.

    קוד PHP Sniffer

    PHP_CodeSniffer הוא כלי חובה ב toolbelt שלך אם אתה מסתכל על מנת לעמוד בתקני קוד PHP. החבילה מכילה כמה סקריפטים PHP לנתח PHP, JS, קוד CSS עבור תאימות עם בחירה של תיעוד סגנון קוד.

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

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

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

    תקנים שונים כמו PSR-0, PSR-1 ו- PSR-2 הם כולם פופולאריים וארוזים בספריית PHP מרחרח.

    אבל אתה יכול למצוא הרבה סטנדרטים קודמות מראש קוד עבור PHP CMS 'כמו WordPress, Magento, ו דרופל. מפתחים על הליבה דרופל אפילו פרסמה מודול קוד המריח הרשמי בשם קודר.

    PHP היא ללא ספק את השפה הקלה ביותר כדי לייעל עם קוד sniffers. אם אתה מחפש רשימה של תקני קוד PHP לבדוק את זה ערך GitHub.

    אחר קוד

    Backend מפתחים לעבוד עם מגוון רחב של שפות מעבר PHP ואת המספרים גדלים מדי שנה. עם שפות חלופיות יש לנו גם קוד חלופי מרחרח כמו ספריות קוד כמו כוסית עבור Python.

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

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

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

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

    לעטוף

    המקום הטוב ביותר להתחיל את הקוד הוא מרחרח עם שפה אחת סטנדרט אחד. HTML / CSS הוא מקום קל להתחיל עבור מפתחי Frontend בעוד PHP הוא לעתים קרובות הבחירה המועדפת בקרב מפתחי backend (במיוחד Wordsress devs).

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

    • למה אתה צריך קידוד תקנים
    • קוד מריח על ידי ג 'ף Atwood
    • קוד PHP Sniffer: התקנה & תצורה
    • מבוא CodeSniffer (חלק 1)
    • חלון ראווה: לנקות קוד Linters