Соглашения об именах для JSON-сериализуемых переменных

Какие соглашения об именах используются для переменных, содержащих JSON-сериализуемые объекты? Нам нужно, чтобы имя переменной напоминало нам только хранить информацию в объекте, который может быть сериализован в JSON без потери информации. Приложения включают в себя сеансы HTTP, столбцы базы данных без поиска, регистрацию данных и сериализацию состояния восстановимого приложения.Соглашения об именах для JSON-сериализуемых переменных

Очевидный соперников, по крайней мере, с точки зрения кого-то в программировании Javascript для Node.js, кажется, не дотягивают:

prefixJSON - JSON фактически синтаксис сериализации, так что это бы правильно быть строка в формате JSON, а не объект
prefixInfo - info часто используется в node.js для любого вида карты, , включая те, которые принимают функции и экземпляры классов ES6.
prefixMap - Тот же вопрос, как info суффиксом
prefixData - Есть ли на самом деле не предполагают ограничение на тип

Лучшее, что я могу сделать, это prefixJSONInfo, prefixJSONData или prefixJSONObject, но я надеялся на что-то более сжатое и читаемое. Префикс может быть длинным и описательным.

Этот вопрос в основном относится к языкам программирования, которые поддерживают переменные типа варианта, такие как Javascript. Эти переменные предназначены для того, чтобы держать mishmash, но программисту нужно напомнить, чтобы ограничить типы значений, которые выбрасываются в mishmash.

источник

2016-06-30 Joe Lapp

Не путать с соглашениями об именах для составных значений объектов JSON, которые рассматриваются здесь: http://stackoverflow.com/questions/5543490/json-naming-convention –

Я нахожу несколько библиотек для строго типизированные языки, используя имена классов JSONObject и JSONArray. Кажется, это стандартные имена для двух наиболее распространенных типов JSON-сериализации. –

В примере кода в сети есть странное явление, которое устанавливает переменную в '' новый JSONObject() ': большинство из этих переменных называются« object »или« obj ». Все экземпляры классов являются объектами, но это экземпляры JSONObject, которые помечаются как имеющие тип «объект». Я вижу имена переменных '' object'', '' obj'', '' jsonObject'', '' jsonObj'' и даже просто '' jo''. –

В этом случае кажется, что конкретная акроним может служить хорошей цели.

JS ПО S erializable

написанные:

JSS или JSS

Примеры:

prefixJss

customerDataJss

sessionInfoJss

Или, может быть, даже:

J СОН S erializable О ▪ Таблица

prefixJSO

prefixJso

Мои $ 0,02. Это может быть больше основано на мнениях, поскольку я не думаю, что есть какие-либо общепризнанные стандарты для этих вещей. Есть лучшие практики, например, вы упомянули (например, короткие, но описательные).Разработчику или команде нужно определить, какие короткие и описательные версии им нравятся (предпочтение команды).

Поверьте мне, я понимаю, как сложно иногда именовать вещи. :)

источник

2016-06-30 21:47:48 ryancdotnet

Эй, мне это нравится! Возможно, нам нужно создать соглашение, как вы предлагаете. Нестандартный суффикс наверняка заставит программистов остановиться. Я дам другим время, чтобы взвесить. Спасибо! –

Вдоль этих строк JSON обозначает JavaScript Object Notation, поэтому, прежде чем мы сериализуем в обозначение, у нас есть объект JavaScript или JSO. Существует несколько способов сделать работу JSO, сделав ее сильным кандидатом. Потрясающие! –

JSObj может быть лучшим подходом. Он воплощает различные значения JSO, а также наводит на размышления. JSO не точно распознается без N. См. Мой комментарий к OP о том, как код по всей сети, по-видимому, предполагает, что объекты JSON имеют тип «объект». –

Соглашения об именах для JSON-сериализуемых переменных

ответ

Смежные вопросы