Recycelbaren Code schreiben

Die große Mehrheit des Codes, den wir schreiben, dient einem einzigen Zweck und wird bei einmaliger Verwendung nie wieder zum Tageslicht gebracht. Dies ist jedoch eine Verschwendung Ihrer wertvollen Zeit, wenn es durchaus möglich ist, Ihren Code so zu schreiben, dass er recycelt und für viele verschiedene Zwecke verwendet werden kann.

Die Herausforderung besteht darin, dass das Schreiben von recycelbarem Code sich vom Schreiben unterscheidet, was als "Wegwerf" -Code bezeichnet werden kann. Bei der letztgenannten Art von Code müssen Sie sich nur darum kümmern, wie andere Menschen Ihre Codeanweisungen interpretieren, wenn Sie diese Anweisungen nicht perfekt geschrieben haben. Wenn Sie recycelbaren Code schreiben, müssen Sie dies jedoch auf eine sehr spezifische Weise tun und Sie müssen wirklich darüber nachdenken, wie jeder, auch Sie selbst, den Code verstehen werden, den Sie zu einem bestimmten Zeitpunkt in der Zukunft geschrieben haben.

Auf diese Weise zu tun, erfordert viel mehr Zeit und Mühe als gewöhnliches Codieren, hat jedoch den Vorteil, dass Sie niemals dieselbe Funktion genau zweimal schreiben müssen. Wie bereits erwähnt, müssen Sie alles auf eine bestimmte Weise tun, um sicherzustellen, dass Ihr Code wirklich für andere Zwecke verwendet werden kann.

Es ist erwähnenswert, dass recycelbarer Code nicht unbedingt dasselbe ist wie ein Plug-In. Wenn Sie ein Plug-In erstellen, entwickeln Sie einen Code, den jeder Benutzer in seine Website aufnehmen und in ihn integrieren kann. Auf diese Weise können Sie ganz einfach einen Effekt erzeugen, indem Sie einige Parameter ändern.

Recycelbarer Code unterscheidet sich dahingehend, dass er nicht unbedingt statisch ist und nicht unbedingt zur Verteilung außerhalb Ihres eigenen Unternehmens bestimmt ist. Unabhängig davon ist es wichtig, dass Sie den korrekten Prozess verwenden, der unten beschrieben wird.

1. Werden Sie ein Meister der Organisation

Wenn Sie Code mit der Absicht erstellen, dass Sie ihn später wiederverwenden können, hilft dies Ihnen nicht viel, wenn Sie ihn nicht finden können. Sie müssen Ihre Codedateien wirklich gut benennen, speichern und klassifizieren.

2. Seien Sie sich bewusst, was "anwendungsspezifisch" und "generisch" ist

Es wird fast immer Code geben, der für Ihre Anwendung spezifisch ist und auf keine andere Weise verwendet werden kann. Beim Erstellen jedes Codeabschnitts sollten Sie entscheiden, ob es sich um anwendungsspezifischen oder generischen Code handelt. Letztendlich möchten Sie viel mehr von den letzteren erstellen als vom ersteren, und es gibt eine gute Möglichkeit, dies zu tun, die ich in Schritt 3 beschreiben werde.

3. Code von Werten trennen

Fest codierte Variablenwerte können ein Problem darstellen, wenn Sie Code auf neue Weise verwenden möchten. Besser ist es, wenn Sie Ihre anfänglichen Variablenwerte in einer Art CSV-Datei speichern und diese Werte dann beim Start der Anwendung laden. Mit dieser Methode können Sie auch die Anfangswerte der Variablen leicht ändern, ohne die ursprüngliche Codedatei zu manipulieren.

4. Versuchen Sie, keine Werte fest zu codieren, die nicht unbedingt sein müssen

Dies bedeutet im Grunde, dass Sie keine Werte hartcodieren sollten. Eine Ausnahme ist der Name der Datei, die geladen wird und alle softcodierten Werte enthält. Auf diese Datei sollte immer relativ zum Stammpfad der Anwendung zugegriffen werden. Andernfalls können Probleme auftreten, wenn Sie die Dateien in ein anderes Betriebssystem verschieben.

5. Vermeiden Sie Leerzeichen in Dateinamen

Nur weil Sie Leerzeichen in Dateinamen einfügen können, müssen Sie dies nicht tun. Dies kann zu Problemen führen, wenn Sie Ihre Dateien in ein anderes Betriebssystem oder ein anderes Dateisystem verschieben. Wenn Sie beispielsweise Ihre Dateien von ext4 nach FAT verschieben, können Probleme auftreten. Interessanterweise zeigt das Windows-Betriebssystem die Namen von Dateien mit ungültigen Zeichen an, gewährt Ihnen jedoch keinen Zugriff auf diese Dateien, selbst wenn Sie sie nur umbenennen möchten.

5. Kommentiere alles wortreich

Wenn Sie Ihren Code schreiben, wissen Sie genau, was er tun soll. Aber lassen Sie ein paar Jahre verstreichen und es ist gut möglich, dass Sie Ihre Absichten vergessen haben. Dieselbe Geschichte ist auch bei der Verwendung des Codes eines anderen Benutzers der Fall, denn wenn sie keine ausführlichen Kommentare zur Verfügung gestellt haben, müssen Sie wertvolle Momente damit verbringen, das Geschriebene zu analysieren und zu interpretieren.

6. Vermeiden Sie das Erstellen von Abhängigkeiten

Einer der größten Schwachstellen in den meisten wiederverwendbaren Codeszenarien besteht darin, dass Sie mit großen Ketten von Dateiabhängigkeiten enden können. Dies geschieht, weil die Benutzer ihre Codeabschnitte auf bestimmte Weise schreiben und sie in einer bestimmten Reihenfolge einschließen, ohne den Grund dafür zu dokumentieren. Dann, bevor Sie es wissen, enden Sie mit einem Left-Pad-Szenario und jeder gerät in Panik, wenn ein Teil des Codes, auf den Ihre Anwendung angewiesen ist, aus irgendeinem Grund AOL wird.

Sie können diese Art von Kernschmelze vermeiden, indem Sie sicherstellen, dass jeder Code-Code leicht gegen einen anderen ausgetauscht werden kann, wie verrückt dokumentiert wird, und natürlich von jedem Abschnitt Sicherungskopien erstellt werden.

Die Dokumentation sollte enthalten, was eine Datei ist, was sie tut und warum sie an der bestimmten Stelle geladen wird, an der sie geladen wird. Dadurch werden potenzielle Abhängigkeitsprobleme vermieden, da jeder Codeteil neu erstellt werden kann, weil sein Zweck bekannt ist.

7. Formatieren Sie Ihren gesamten Code wirklich ordentlich

Natürlich ist es eine gute Idee, dies immer zu tun, aber es ist besonders wichtig, wenn Sie wiederverwendbaren Code schreiben. Sie sollten auch einen sehr konsistenten Codierstil beibehalten und ihn nicht ändern. Wenn Sie zum Beispiel Ihre konstanten Namen in camelCase in Großbuchstaben und Variablennamen schreiben, sollten Sie dies mit absoluter Konsistenz tun.

8. Jeder Codeabschnitt hat einen bestimmten Zweck

Ihre Mission ist es zu verstehen, was dieser Zweck ist. Sie müssen vermeiden, mehrere Zwecke pro Block zuzulassen. Wenn Sie zum Beispiel einen Teil des Codes haben, der die ursprünglichen Variablenwerte lädt, sollte er nichts anderes tun. Ihr nächster Codeabschnitt sollte den nächsten erforderlichen Vorgang ausführen. Wie streng ist diese Regel? Nun, Ihre Hauptfunktion sollte nichts anderes tun, als alle anderen Funktionen aufzurufen.

Es ist viel schwieriger, gutes recycelbares Gut zu schreiben, als man denken würde, bevor es versucht wird. Unabhängig von Ihren ursprünglichen Absichten werden Sie wahrscheinlich feststellen, dass etwa 80% des Codes, den Sie schreiben, anwendungsspezifisch und nicht generisch sein wird. Die meisten Menschen schwärmen von recycelbarem Code, ohne sich darüber im Klaren zu sein, wie sie ihn in der Zukunft tatsächlich verwenden werden, mit dem Ergebnis, dass sie mehr Arbeit für sich selbst schaffen, was das Ziel ist. Hoffentlich hat Ihnen dieser Artikel geholfen, dieses Schicksal zu vermeiden.

Headerbild mit freundlicher Genehmigung von DKNG

Bogdan Rancea

Bogdan ist Gründungsmitglied von Inspired Mag und hat in diesem Zeitraum fast 6-Jahre Erfahrung gesammelt. In seiner Freizeit studiert er gern klassische Musik und erforscht die bildende Kunst. Er ist auch ziemlich besessen von Fixies. Er besitzt bereits 5.