Wie lautet die Namenskonvention für Javascript-Dateinamen?

Question

Sollen die Dateien "irgendwas-mit-Hyphens.js", "camelCased.js" oder anders heißen?

Ich habe die Antwort auf diese Frage nicht gefunden aquí .

Answer 1

Eine mögliche Namenskonvention ist die Verwendung eines Namensschemas, das dem von jQuery verwendeten ähnelt. Es ist nicht universell angenommen, aber es ist ziemlich häufig.

product-name.plugin-ver.sion.filetype.js

wo die product-name + plugin Paar kann auch für eine Namensraum und eine Modul . Les version y filetype sind in der Regel fakultativ.

filetype kann etwas sein, das sich auf den Inhalt der Datei bezieht. Oft gesehen sind:

• min für verkleinerte Dateien
• custom für selbst erstellte oder geänderte Dateien

Beispiele:

• jquery-1.4.2.min.js
• jquery.plugin-0.1.js
• myapp.invoice.js

Answer 2

Ich bin mir keiner besonderen Konvention für Javascript-Dateien bewusst, da sie im Gegensatz zu CSS- oder HTML-Dateien oder anderen Dateitypen im Web nicht wirklich einzigartig sind. Es gibt einige "sichere" Dinge, die Sie tun können, die es weniger wahrscheinlich, dass Sie versehentlich in einem Cross-Plattform-Problem laufen:

1. Verwenden Sie alle Dateinamen in Kleinbuchstaben. Es gibt einige Betriebssysteme, die bei Dateinamen nicht zwischen Groß- und Kleinschreibung unterscheiden, und die Verwendung von Kleinbuchstaben verhindert, dass versehentlich zwei Dateien verwendet werden, die sich nur in der Groß- und Kleinschreibung unterscheiden, was auf einigen Betriebssystemen nicht funktionieren könnte.
2. Verwenden Sie keine Leerzeichen im Dateinamen. Obwohl dies technisch machbar ist, gibt es viele Gründe, warum Leerzeichen in Dateinamen zu Problemen führen können.
3. Ein Bindestrich ist als Worttrenner in Ordnung. Wenn Sie eine Art Trennzeichen für mehrere Wörter verwenden möchten, anstatt eines Leerzeichens oder eines Großbuchstabens wie in various-scripts.js Ein Bindestrich ist ein sicheres und nützliches Trennzeichen, das häufig verwendet wird.
4. Erwägen Sie die Verwendung von Versionsnummern in Ihren Dateinamen. Wenn Sie Ihre Skripte aktualisieren möchten, sollten Sie die Auswirkungen des Browser- oder CDN-Cachings berücksichtigen. Der einfachste Weg, langfristige Zwischenspeicherung (für Geschwindigkeit und Effizienz), aber sofortige und sichere Upgrades zu nutzen, wenn Sie eine JS-Datei aktualisieren, besteht darin, eine Versionsnummer in den bereitgestellten Dateinamen oder Pfad aufzunehmen (wie jQuery es mit jquery-1.6.2.js tut) und dann diese Versionsnummer bei jedem Upgrade/jeder Änderung der Datei zu erhöhen/zu ändern. Dadurch wird sichergestellt, dass keine Seite, die die neuere Version anfordert, jemals die ältere Version aus einem Cache erhält.

Answer 3

Es gibt keinen Beamten, universal Konvention für die Benennung von JavaScript-Dateien.

Es gibt einige verschiedene Möglichkeiten:

• scriptName.js
• script-name.js
• script_name.js

sind alle gültigen Namenskonventionen, jedoch I Bevorzugen Sie die von jQuery vorgeschlagene Namenskonvention (für jQuery-Plugins, obwohl sie für jedes JS funktioniert)

• jquery.pluginname.js

Das Schöne an dieser Benennungskonvention ist, dass sie ausdrücklich beschreibt die hinzugefügte globale Namespace-Verschmutzung.

• foo.js fügt hinzu. window.foo
• foo.bar.js fügt hinzu. window.foo.bar

---

Denn ich habe die Versionsangabe vergessen: Sie sollte nach dem vollständigen Namen stehen, vorzugsweise durch einen Bindestrich getrennt, mit Punkten zwischen Haupt- und Nebenversion:

• foo-1.2.1.js
• foo-1.2.2.js
• ...
• foo-2.1.24.js

Answer 4

In der Frage in dem von Ihnen angegebenen Link geht es um die Benennung von JavaScript-Variablen, nicht um die Benennung von Dateien, also vergessen Sie das für den Kontext, in dem Sie Ihre Frage stellen.

Was die Benennung der Dateien angeht, so ist dies eine reine Geschmacksfrage. Ich ziehe es vor, Dateien mit Bindestrichen zu benennen, weil ich dann nicht zur Umschalttaste greifen muss, wie es bei Dateinamen in CamelCase der Fall ist, und weil ich mir keine Gedanken über die Unterschiede zwischen Windows- und Linux-Dateinamen machen muss (bei Windows-Dateinamen wird die Groß- und Kleinschreibung nicht beachtet, zumindest bis XP).

Die Antwort lautet also, wie so oft, "es kommt darauf an" oder "es liegt an Ihnen".

Die einzige Regel, die Sie befolgen sollten, ist, dass Sie bei der Wahl der Konvention konsequent sein sollten.

Answer 5

Im Allgemeinen bevorzuge ich Bindestriche mit Kleinbuchstaben, aber eine Sache, die noch nicht erwähnt wurde, ist, dass es manchmal schön ist, wenn der Dateiname genau mit dem Namen eines einzelnen Moduls oder einer darin enthaltenen instanzierbaren Funktion übereinstimmt.

Ich habe zum Beispiel ein revealing-Modul, das mit var knockoutUtilityModule = function() {...} in einer eigenen Datei namens knockoutUtilityModule.js, obwohl ich objektiv gesehen knockout-utility-module.js vorziehe.

Da ich einen Bündelungsmechanismus verwende, um Skripte zu kombinieren, habe ich instanzierbare Funktionen (Templates für Ansichtsmodelle usw.) aus Gründen der Wartungsfreundlichkeit jeweils in einer eigenen Datei im C#-Stil definiert. Zum Beispiel, ProductDescriptorViewModel lebt auf seine eigene innerhalb ProductDescriptorViewModel.js (Ich verwende Großbuchstaben für instanzierbare Funktionen).