Το στιλ κώδικα του Total.js: ονόματα, αρχεία, CSS, SQL και συστατικά

Τα έργα Total.js μοιράζονται ένα στιλ, και αυτό είναι δύναμη: ανοίγετε οποιοδήποτε και ξέρετε πού είναι τα πράγματα και πώς γράφονται. Αυτή η σελίδα συγκεντρώνει σε ένα σημείο τις συμβάσεις των Total.js guidelines (η αναθεώρηση που εξετάστηκε καταγράφεται στο ai-sources.json). Ακολουθήστε πρώτα το στιλ του έργου στο οποίο δουλεύετε· αυτοί είναι οι προεπιλεγμένοι κανόνες για νέο κώδικα. Για την πλευρά του framework, διαβάστε τις συμβάσεις του Total.js 5 για βοηθούς κώδικα.

JavaScript

• Αρχεία: ονόματα με πεζά γράμματα, με παύλες αντί για κάτω παύλες (user-profile.js).
• Διάταξη: tabs (πλάτος 4), χωρίς περιττά κενά και ερωτηματικό στο τέλος κάθε εντολής.
• Συμβολοσειρές: μονά εισαγωγικά για τις σύντομες συμβολοσειρές.
• Μεταβλητές: χρησιμοποιήστε var ή let μέσα στις μεθόδους και κρατήστε το const για την κορυφή ενός module.
• Βρόχοι: όπου ταιριάζει, προτιμάται ένα κλασικό for από το forEach().
• Εξαρτήσεις: κρατήστε τις στο ελάχιστο και ακολουθήστε τον κώδικα που υπάρχει ήδη.

Ονόματα που ταξιδεύουν ανάμεσα στα έργα

Χρησιμοποιείτε παντού το ίδιο όνομα για το ίδιο πράγμα, ώστε ο κώδικας να μεταφέρεται ανάμεσα στα έργα και να διαβάζεται με μια ματιά:

Όνομα	Χρήση
id, name, value, email	το συνηθισμένο αναγνωριστικό, όνομα, τιμή και email
items or arr, item	μια λίστα και ένα από τα στοιχεία της
tmp	μια προσωρινή τιμή
dtcreated, dtupdated	ημερομηνίες δημιουργίας και ενημέρωσης

Τα σχήματα έχουν όνομα στον πληθυντικό που ξεκινά με κεφαλαίο (Contacts), και τα αναγνωριστικά δημιουργούνται με το UID().

Χρήση του require()

Στην κορυφή ενός module χρησιμοποιήστε const και ξεκινήστε το όνομα της μεταβλητής με κεφαλαίο: const Fs = require('fs');.

CSS

• Ονόματα αρχείων με πεζά και παύλες.
• Γράφετε κάθε κανόνα στιλ σε μία γραμμή.
• Μη γράφετε με το χέρι τα προθέματα των προγραμμάτων περιήγησης: προσθέστε το σχόλιο /*auto*/ και το Total.js προθεματίζει τους κανόνες για εσάς.
• Μονά εισαγωγικά και απλό CSS αντί για LESS ή SASS.

Πρόσθετα και συστατικά (jComponent)

• Πεζά γράμματα για τα ονόματα πρόσθετων, συστατικών και τις εγγραφές των FUNC., MAIN. και REPO., καθώς και για τις μεταβλητές.
• Αποφύγετε τις κάτω παύλες όπου μπορείτε και κρατήστε την εμφώλευση σε δύο ή τρία επίπεδα.
• Ένα πρόσθετο γράφεται με exports.· ένα συστατικό χρησιμοποιεί self, config και cls.
• Σχεδιάστε για επαναχρησιμοποίηση.

Σενάρια SQL

• Ονόματα πινάκων και πεδίων με πεζά, tabs για εσοχές και ερωτηματικό στο τέλος κάθε εντολής.
• Αφαιρέστε τις περιττές μετατροπές τύπου, μορφοποιήστε το σενάριο και κρατήστε πίνακες, όψεις, διαδικασίες ή συναρτήσεις και ευρετήρια σε ξεχωριστά σενάρια.

Πρόθεμα	Για
tbl_	πίνακες, με το όνομα στον ενικό
cl_	λίστες κωδικών
view_	όψεις
sp_	αποθηκευμένες διαδικασίες
fn_	συναρτήσεις

Στα πεδία, το dt ξεκινά μια ημερομηνία, το is ξεκινά μια λογική τιμή, τα κλειδιά ακολουθούν το πρότυπο id ή userid, και χρησιμοποιείται text αντί για varchar. Χρησιμοποιήστε id, name και dtcreated όπου ταιριάζουν και ταξινομήστε τις στήλες ως αναγνωριστικά, κύρια πεδία, αριθμούς, λογικές τιμές και ημερομηνίες, με τους περιορισμούς ξένου κλειδιού στο τέλος.

Φάκελοι

Βάλτε τις εικόνες στο /img/, τα σενάρια στο /js/, τα στιλ στο /css/, τις γραμματοσειρές στο /fonts/ και τα βίντεο στο /videos/, και ονομάστε τα αρχεία με παύλες.

Γιατί βοηθά

Ένα κοινό στιλ κάνει ένα έργο εύκολο να παραδοθεί, να ελεγχθεί και να επεκταθεί, και δίνει στον βοηθό AI ένα σαφές πρότυπο να ακολουθήσει. Δώστε στον βοηθό σας αυτή τη σελίδα μαζί με τις συμβάσεις του Total.js 5 για βοηθούς κώδικα και ο κώδικάς του θα ταιριάζει με την υπόλοιπη εφαρμογή σας.