Namenskonventionen für serialisierbare JSON-Variablen

Welche Namenskonventionen verwenden Personen, die Variablen verwenden, die JSON-serialisierbare Objekte enthalten? Wir möchten, dass der Name der Variablen uns daran erinnert, nur Informationen in dem Objekt zu speichern, die in JSON serialisiert werden können, ohne Informationen zu verlieren. Zu den Anwendungen gehören HTTP-Sitzungen, nicht durchsuchbare Datenbankspalten, Datenprotokollierung und die Wiederherstellung wiederherstellbarer Anwendungszustände.Namenskonventionen für serialisierbare JSON-Variablen

Die offensichtlichen Anwärter, zumindest aus der Perspektive von jemandem Programmierung in Javascript für node.js, scheinen kurz zu greifen:

prefixJSON - JSON ist eigentlich eine Serialisierung Syntax, so würde dies richtig sein, Zeichenfolge im JSON-Format, kein Objekt
prefixInfo - info wird häufig in node.js für jede Art von Karte verwendet, einschließlich , die Funktionen und Instanzen von ES6-Klassen enthalten.
prefixMap - gleiche Problem wie die info Suffix
prefixData - Ist vorschlagen nicht wirklich eine Einschränkung für die Art

Das Beste, was ich prefixJSONInfo tun kann, prefixJSONData oder prefixJSONObject, aber ich hatte gehofft, für etwas prägnanter und lesbarer. Das Präfix kann auch lang und beschreibend sein.

Diese Frage bezieht sich hauptsächlich auf Programmiersprachen, die variantenartige Variablen wie Javascript unterstützen. Diese Variablen sollen einen Mischmasch enthalten, aber der Programmierer muss daran erinnert werden, die Arten von Werten zu begrenzen, die in den Mischmasch geworfen werden.

Quelle

2016-06-30 Joe Lapp

Nicht zu verwechseln mit Namenskonventionen für die konstituierenden Werte von JSON-Objekten, die hier angesprochen werden: http://stackoverflow.com/questions/5543490/json-naming-convention –

Ich finde mehrere Bibliotheken für stark typisierte Sprachen mit den Klassennamen JSONObject und JSONArray. Dies scheinen die Standardnamen für die beiden am häufigsten verwendeten JSON-serialisierten Typen zu sein. –

Es gibt ein seltsames Phänomen im Beispielcode im gesamten Netzwerk, das eine Variable auf ein '' neues JSONObject() '' setzt: Die meisten dieser Variablen heißen "object" oder "obj". Alle Instanzen von Klassen sind Objekte, aber die JSONObject-Instanzen werden als vom Typ "Objekt" bezeichnet. Ich sehe die Variablennamen "object", obj, jsonObject, jsonObj und sogar nur –

In diesem Fall scheint ein bestimmtes Akronym einen guten Zweck zu erfüllen.

JS ON S erializable

geschrieben:

JSS oder Jss

Beispiele:

prefixJss

customerDataJss

sessionInfoJss

Oder vielleicht sogar:

J SON S erializable O bject

prefixJSO

prefixJso

Meine $ 0,02. Dies könnte eher auf Meinungen basieren, da ich nicht glaube, dass es weltweit akzeptierte Standards für diese Dinge gibt. Es gibt Best Practices, wie Sie erwähnt haben (wie kurz, aber beschreibend).Es liegt am Entwickler oder Team zu bestimmen, welche kurze und beschreibende Versionen sie (Teampräferenz) mögen.

Vertrauen Sie mir, tho, ich verstehe, wie schwierig Namen manchmal ist. :)

Quelle

2016-06-30 21:47:48 ryancdotnet

Hey, das gefällt mir! Vielleicht müssen wir eine Konvention erstellen, wie Sie es vorschlagen. Ein Nicht-Standard-Suffix wird sicherlich Programmierer dazu bringen, zu pausieren. Ich werde den anderen auch etwas Zeit geben, um sie zu berücksichtigen. Vielen Dank! –

In diesem Sinne steht JSON für JavaScript Object Notation, also bevor wir in die Notation serialisiert haben, haben wir ein JavaScript-Objekt oder JSO. Es gibt mehrere Möglichkeiten, JSO zum Laufen zu bringen und es zu einem starken Kandidaten zu machen. Genial! –

JSObj kann der beste Ansatz sein. Es verkörpert die verschiedenen Bedeutungen von JSO und ist gleichzeitig suggestiv. JSO ist ohne das N nicht genau erkennbar. Siehe meinen OP-Kommentar, wie der Code im gesamten Netz darauf hinweist, dass JSON-Objekte vom Typ "Objekt" sind. –

Namenskonventionen für serialisierbare JSON-Variablen

Antwort

Verwandte Themen