Der Total.js-Codestil: Namen, Dateien, CSS, SQL und Komponenten

Total.js-Projekte teilen einen Stil, und das ist eine Stärke: Sie öffnen eines davon und wissen, wo die Dinge liegen und wie sie geschrieben sind. Diese Seite fasst die Konventionen der Total.js guidelines an einer Stelle zusammen (die geprüfte Revision steht in ai-sources.json). Folgen Sie zuerst dem Stil des Projekts, in dem Sie arbeiten; dies sind die Standardregeln für neuen Code. Zur Framework-Seite lesen Sie Total.js-5-Konventionen für Coding-Assistenten.

JavaScript

• Dateien: Kleinbuchstaben, mit Bindestrichen statt Unterstrichen (user-profile.js).
• Layout: Tabs (Breite 4), keine überflüssigen Leerzeichen und ein Semikolon am Ende jeder Anweisung.
• Strings: einfache Anführungszeichen für kurze Strings.
• Variablen: verwenden Sie var oder let in Methoden und heben Sie const für den Anfang eines Moduls auf.
• Schleifen: wo es passt, wird eine klassische for-Schleife forEach() vorgezogen.
• Abhängigkeiten: halten Sie sie minimal und folgen Sie dem vorhandenen Code.

Namen, die zwischen Projekten mitreisen

Verwenden Sie überall denselben Namen für dieselbe Sache, damit sich Code zwischen Projekten verschieben und auf einen Blick lesen lässt:

Name	Verwendung
id, name, value, email	der übliche Bezeichner, Name, Wert und die E-Mail
items or arr, item	eine Liste und eines ihrer Elemente
tmp	ein temporärer Wert
dtcreated, dtupdated	Datum der Erstellung und der Aktualisierung

Schemas haben einen Namen im Plural, der mit einem Großbuchstaben beginnt (Contacts), und Bezeichner werden mit UID() erzeugt.

require() verwenden

Verwenden Sie am Anfang eines Moduls const und beginnen Sie den Variablennamen mit einem Großbuchstaben: const Fs = require('fs');.

CSS

• Dateinamen in Kleinbuchstaben mit Bindestrichen.
• Schreiben Sie jede Stilregel in eine einzige Zeile.
• Schreiben Sie keine Browser-Präfixe von Hand: Fügen Sie den Kommentar /*auto*/ hinzu, und Total.js setzt die Präfixe für Sie.
• Einfache Anführungszeichen und reines CSS statt LESS oder SASS.

Plugins und Komponenten (jComponent)

• Kleinbuchstaben für Namen von Plugins, Komponenten und die Einträge von FUNC., MAIN. und REPO. sowie für Variablen.
• Vermeiden Sie Unterstriche, wo es geht, und halten Sie die Verschachtelung bei zwei oder drei Ebenen.
• Ein Plugin wird mit exports. geschrieben; eine Komponente verwendet self, config und cls.
• Entwerfen Sie für Wiederverwendung.

SQL-Skripte

• Namen von Tabellen und Feldern in Kleinbuchstaben, Tabs zum Einrücken und ein Semikolon am Ende jeder Anweisung.
• Entfernen Sie unnötige Typumwandlungen, formatieren Sie das Skript und halten Sie Tabellen, Views, Prozeduren oder Funktionen und Indizes in getrennten Skripten.

Präfix	Für
tbl_	Tabellen, mit dem Namen im Singular
cl_	Codelisten
view_	Views
sp_	gespeicherte Prozeduren
fn_	Funktionen

In den Feldern beginnt dt ein Datum, is einen booleschen Wert, Schlüssel folgen dem Muster id oder userid, und statt varchar wird text verwendet. Verwenden Sie id, name und dtcreated, wo sie passen, und ordnen Sie die Spalten als Bezeichner, Hauptfelder, Zahlen, boolesche Werte und Datumsangaben, mit den Fremdschlüssel-Constraints am Ende.

Ordner

Legen Sie Bilder in /img/, Skripte in /js/, Stile in /css/, Schriften in /fonts/ und Videos in /videos/ ab und benennen Sie die Dateien mit Bindestrichen.

Warum es hilft

Ein gemeinsamer Stil macht ein Projekt leicht zu übergeben, zu prüfen und zu erweitern und gibt einem KI-Assistenten ein klares Muster. Geben Sie Ihrem Assistenten diese Seite zusammen mit den Total.js-5-Konventionen für Coding-Assistenten, und sein Code passt zum Rest Ihrer Anwendung.