דוגמה לתגובת JSON - כיצד להגיב בקבצי JSON

אם אתה מתקשה להוסיף הערות לקובץ JSON שלך, יש סיבה טובה: JSON אינו תומך בתגובות.

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

עם זאת, יש דרך לעקיפת הבעיה. וזה מה שעוסק במאמר זה: כיצד להוסיף הערות לקובץ JSON שלך.

הוסף נתונים כהערות

דרך לעקוף את נושא ההערות היא להוסיף נתונים לקובץ JSON שלך שמתפקדים כהערות.

בואו נעבור דוגמה, החל ממידע זה בקובץ JSON שלנו:

{ "sport": "basketball", "coach": "Joe Smith", "wins": 15, "losses": 5 } 

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

{ "_comment1": "this is my comment", "sport": "basketball", "coach": "Joe Smith", "wins": 15, "losses": 5 } 

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

 "__comment2__": "this is another comment", 

קו תחתון עוזר להבדיל את ההערה משאר הנתונים בקובץ שלנו.

מילת אזהרה

יש לזכור פרט חשוב.

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

הנה למה שאנחנו מתכוונים.

זה הקוד בקובץ שלנו data.json:

{ "_comment1": "this is my comment", "sport": "basketball", "coach": "Joe Smith", "wins": 15, "losses": 5 } 

כעת אנו קוראים את הנתונים מהקובץ read_comments.py:

import json with open("data.json", mode="r") as j_object: data = json.load(j_object) print(data) 

התוצאה כוללת את ההערה שלנו:

{'_comment1': 'this is my comment', 'sport': 'basketball', 'coach': 'Joe Smith', 'wins': 15, 'losses': 5} 

אנו יכולים אפילו לחלץ את ערך ההערה מאובייקט JSON this is my comment::

import json with open("data.json", mode="r") as j_object: data = json.load(j_object) print(data["_comment1"]) 

זכור כי ההערה היא רק הערה בעיני היזם - לא המחשב.

סוג אחר של תגובה

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

# Here's my comment word = "house" for letter in word: print(letter) 

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

אפשרויות תגובה

JSMin הוא אפשרות נוספת שיש לקחת בחשבון.

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

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

אני כותב על למידה לתכנת ועל הדרכים הטובות ביותר לעשות זאת ( amymhaddad.com).