JSON Dosyasında Yorum Satırı
Bu makalede herhangi bir json dosyası içerisinde yorum satırı tutulup tutulamayacağı ile ilgili konuyu açıklığa kavuşturmaya çalışacağım.
Üzerinde çalıştığımız proje ile ilgili mobil geliştirici arkadaşımızın çalışması için bazı json dosyaları oluşturulması gerekiyordu. Bu işi yerine getirecek kişi olarak eldeki verileri json formatına getirirken birkaç noktada “Acaba doğru mu anladım buradaki bilgiyi?” diye kendi kendime sormam gerekti.
Her şüphe duyduğumda bu dosyaları kullanacak arkadaşa soru sorup mesaisini bölmemek için “Acaba json içerisinde yorum tutuluyor mu?” diye kendi kendime bir soru daha sordum. Eğer böyle bir şey varsa böylece tek seferde kendisi kontrollerini yapabilir ve zamanı daha verimli kullanmış olurduk. Tüm bunlar sonunda araştırmalarım beni bu makaleyi yazmaya yönlendirdi. Bu sayede Türkçe içeriğe küçük de olsa bir katkı sunmak istedim.
Kestirmeden cevap vereyim: json dosyasında diğer yazılım dillerinden aşina olduğumuz şekilde bir yorum satırı tutma özelliği yok. Yani derleyicide kodunuza yorum satırı olarak eklediğiniz kısımlar kodunuzu çalıştırdığınızda işleme alınmaz; fakat json dosyasına ne eklerseniz ekleyin veri olarak dikkate alınacaktır.
Bunun yanında üzerinde ittifak edilen bazı noktalar da yok değil. Diyelim ki elinizde json formatında şöyle bir veri var:
{
"business":"Grocery",
"location":"İstanbul",
"revenue":2000,
"profit":500
}…ve siz bu veriyi hazırlarken bir yorumda bulunmak istiyorsunuz. O halde şunu deneyebilirsiniz:
{
"_comment1":"business isimleri bölgeye göre farklı olabilir"
"business":"Market",
"location":"İstanbul",
"revenue":2000,
"profit":500
}…ya da iki tane alt çizgi ile başlayıp aynı şekilde biten şöyle bir seçeneği de deneyebilirsiniz:
{
"__comment__":"Bu bir yorumdur.",
}Böylece yorumlarınızın json içerisinde fark edilebilir olmasını sağlarsınız.
Uyarı: Bu iki yöntem genelde üzerinde en çok ittifak edilen yöntemler olarak geçiyor. Yine de unutulmaması gereken nokta, nasıl bir yorum eklerseniz ekleyin, bu yorumlar json içerisinde normal veri gibi muamele görecektir. Dolayısıyla bu yöntem sizinle derleyici arasında değil, sizinle geliştirici arasında bir kontrol mekanizması olacaktır sadece.
JSMin
JavaScript dosyalarındaki ekstra boşlukları ve yorumları kaldıran bir araç var: JSMin. Bu araç aynı zamanda JSON dosyaları işleme alınmadan önce içerisindeki yorumları ayrıştırabiliyor.
CommentJSON
JSON dosyalarının Python ve JavaScript sitilinde yorumlarla oluşturulmasına yardım eden bir Python paketidir. Github linki için tıklayınız.
>>> import commentjson
>>>
>>> json_string = """{
... "name": "Lorem Ipsum", # Person's name
... "location": "Lorem, Ipsum", // Person's location
...
... # Section contains info about
... // person's appearance
... "appearance": {
... "hair_color": "black",
... "eyes_color": "black",
... "height": "6"
... }
... }"""
>>>
>>> json_loaded = commentjson.loads(json_string)
>>> print json_loaded{u'appearance': {hair_color': u'black', u'eyes_color': u'black', u'height': u'6'}, u'name': u'Lorem Ipsum', u'location': u'Lorem, Ipsum'}
Kaynaklar: FreeCodecamp, JSMin, Github
