15 Möglichkeiten zum Schreiben von selbstdokumentierendem JavaScript

Schlüsselpunkte zum Schreiben selbstdokumentierter JavaScript-Code

In diesem Artikel wird untersucht, wie selbst dokumentiertes und aufrechterhaltener selbstdokumentierter JavaScript-Code über strukturierte Techniken, Namenskonventionen und Syntaxtechniken aufrechterhalten werden. Während selbstdokumentierter Code die Notwendigkeit von Kommentaren verringern kann, ersetzt er jedoch nicht vollständig gute Kommentare und umfassende Dokumentation.

Kernfähigkeiten

• Strukturierte Technologie: Verschieben Sie den Code in eine Funktion, ersetzen Sie bedingte Ausdrücke durch Funktionen und verwenden Sie reine Funktionen, um den Code klarer und zu verstehen.
• Namenskonvention: Namensvariablen, Funktionen und Klassen mit sinnvollen Namen zur Verbesserung der Code -Lesbarkeit.
• Syntaxfähigkeiten: Vermeiden Sie die Verwendung von Syntaxtechniken, verwenden Sie benannte Konstanten und machen Sie den Code klarer.
• Code mit Vorsicht extrahieren: Vermeiden Sie einen Überextrahieren von Code, um kurze Funktionen zu verfolgen, was die Verständlichkeit des Codes verringern kann.

Technische Übersicht

wir teilen den selbstdokumentierten Code in drei Kategorien:

• Struktur: Verwenden Sie die Struktur von Code oder Verzeichnis, um den Zweck des Codes zu klären.
• Namensbezogen: Zum Beispiel die Benennung von Funktionen oder Variablen.
• Syntaxbezogen: Sprachfunktionen verwenden (oder vermeiden), um den Code klarer zu machen.

strukturierte Technologie

• Code in Funktion verschieben: Verschieben Sie den vorhandenen Code in eine neue Funktion, um seine Funktionen klarer zu machen. Zum Beispiel kann var width = (value - 0.5) * 16; als:
neu geschrieben werden

var width = emToPixels(value);

function emToPixels(ems) {
    return (ems - 0.5) * 16;
}

• Ersetzen Sie bedingte Ausdrücke durch Funktionen: Umwandeln komplexe bedingte Aussagen in Funktionen, um die Lesbarkeit zu verbessern.

• Ersetzen Sie Ausdrücke durch Variablen: Komplexe Ausdrücke in mehrere Variablen zersetzen, um die Verständlichkeit zu verbessern.

• Klasse und Modulschnittstellen: Die öffentlichen Methoden und Eigenschaften einer Klasse können als Dokumentation ihrer Verwendung verwendet werden. Eine klare Schnittstelle kann die Verwendung der Klasse direkt widerspiegeln.

• Codegruppierung: Gruppierungsbezogene Codes können darauf hinweisen, dass es einen Zusammenhang zwischen den Codes gibt und die Wartung erleichtert.

• Verwenden Sie reine Funktionen: reine Funktionen sind einfacher zu verstehen, da ihre Ausgabe nur von Eingabeparametern abhängt und keine Nebenwirkungen hat.

• Verzeichnis und Dateistruktur: organisieren Dateien und Verzeichnisse gemäß den vorhandenen Namenskonventionen im Projekt, um die Code -Suche und -verständnis zu erleichtern.

Namensfähigkeiten

• Funktion umbenennen: Verwenden Sie Verben in aktiver Stimme und geben Sie den Rückgabewert explizit an. Vermeiden Sie es, vage Wörter wie "Handle" oder "verwalten" zu verwenden.

• Variable umbenennen: Verwenden Sie einen aussagekräftigen Namen und geben Sie die Einheit an (z. B. widthPx). Vermeiden Sie die Verwendung von Abkürzungen.

• Halten Sie sich an etablierte Namenskonventionen an: einen konsistenten Namensstil im Projekt beibehalten.

• Verwenden Sie aussagekräftige Fehlermeldungen: Stellen Sie sicher, dass die vom Code abgegebenen Fehlermeldungen beschreibend sind und relevante Informationen enthalten, die den Fehler verursacht haben.

Grammatikfähigkeiten

• Vermeiden Sie die Verwendung von Grammatikspitzen: Vermeiden Sie es, schwer zu verständige Grammatik-Spitzen wie imTricky && doMagic(); zu verwenden, und verwenden Sie Clearer if -Anweisungen.

• Verwenden Sie benannte Konstanten, um magische Werte zu vermeiden: Verwenden Sie benannte Konstanten anstelle von magischen Werten, um die Code -Lesbarkeit und -wartbarkeit zu verbessern.

• Vermeiden Sie boolesche Flags: boolesche Flags können den Code schwer zu verstehen machen und sollte für einen klareren Ansatz berücksichtigt werden.

• Verwenden Sie die Sprachfunktionen vollständig: Verwenden Sie die von Sprachen bereitgestellten Funktionen wie Array -Iterationsmethoden, um den Code prägnanter und leicht verständlicher zu gestalten.

Anti-Mode

• Überextrahieren Code für kurze Funktionen: Vermeiden Sie das Überextrahieren von Code, um kurze Funktionen zu verfolgen, was die Verständlichkeit des Codes verringern kann.

• zwingen Sie es nicht: Wenn eine Methode nicht geeignet ist, zwingen Sie es nicht, sie zu verwenden.

Zusammenfassung

Das Schreiben von selbstdokumentierten Code kann die Wartbarkeit des Codes erheblich verbessern und die Notwendigkeit von Kommentaren verringern. Selbstdokumentierter Code kann jedoch Dokumente oder Kommentare nicht vollständig ersetzen. Gute Anmerkungen und API -Dokumentationen sind für große Projekte immer noch von entscheidender Bedeutung.

Das obige ist der detaillierte Inhalt von15 Möglichkeiten zum Schreiben von selbstdokumentierendem JavaScript. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!