Ein Ausschnitt ohne Kontext wird zu einer Rateübung. Sie erinnern sich vielleicht noch daran, warum Sie es heute gespeichert haben, aber sechs Monate später können die fehlenden Eingaben, Abhängigkeiten oder Annahmen wichtiger sein als der Code selbst.

Speichern Sie das Problem mit der Lösung

Geben Sie der Notiz einen aussagekräftigen Titel und erklären Sie, was das Snippet bewirkt. Notieren Sie die Sprache, die relevante Version und alle Abhängigkeiten. Fügen Sie die kleinste Beispieleingabe und die Ausgabe ein, die Sie beim Testen erwartet haben.

Wenn das Snippet aus einer Quelle stammt, bewahren Sie den Quelllink auf und prüfen Sie die Bedingungen zur Wiederverwendung. Entfernen Sie die Namensnennung nicht, nur weil das Fragment kurz ist. Halten Sie Geheimnisse, echte Kundendaten und umgebungsspezifische Anmeldeinformationen aus dem gespeicherten Beispiel fern.

Erklären Sie die Annahmen

Geben Sie an, welche Eingaben der Code akzeptiert und welche nicht. Beachten Sie, ob es Dateien ändert, einen Dienst aufruft oder Berechtigungen benötigt. Ein Befehl, der wie eine praktische Verknüpfung aussieht, kann in einem anderen Verzeichnis eine ganz andere Wirkung haben.

Verwenden Sie einen abgeschirmten Codeblock mit einer Sprachbezeichnung, sofern Ihr Markdown-Renderer dies unterstützt. Der Projekteditor von MeatPad kann die Notiz neben den zugehörigen Quelldateien aufbewahren. Syntaxhervorhebung erleichtert das Lesen; es stellt nicht sicher, dass das Snippet korrekt ist.

Vor Wiederverwendung erneut prüfen

Führen Sie das Snippet anhand eines kleinen, unkritischen Beispiels in der Umgebung aus, in der Sie es verwenden möchten. Vergleichen Sie das Ergebnis mit der gespeicherten Erwartung. Abhängigkeiten und APIs können sich ändern, nachdem der Hinweis geschrieben wurde.

Fügen Sie ein Datum der letzten Überprüfung hinzu, an dem das Fragment Teil eines wiederholten Workflows wird. Wenn sich der Kontext zu einem ganzen Programm entwickelt hat, stufen Sie es in ein gepflegtes Skript um, anstatt Korrekturen in einer Notiz anzusammeln. Das nützliche Snippet ist dasjenige, das Sie erklären und testen können, und nicht nur das, das Sie einfügen können.

Quellen und Produktdetails

Beginnen Sie mit einer Notiz. MeatPad bietet Notizen, Markdown und Projektdateien einen lokalen Arbeitsbereich auf Ihrem Mac, ohne dass ein Konto erforderlich ist.

Entdecken Sie MeatPad →