Wenn man Code für ein Programm schreibt, ist es einfach, alle Fehler zu beheben und sie korrekt kompilieren zu lassen, aber es ist viel schwieriger für eine andere Person, es zu lesen. Hier sind einige Tipps, die Ihnen helfen, die Lesbarkeit Ihres Codes zu verbessern.

Schritte

  1. 1 Menschen, die Code pflegen, sind nie so versiert wie der ursprüngliche Autor. Sie haben möglicherweise schlechtere Programmierkenntnisse und wissen weniger über das Projekt. Dies ist die Person, für die Sie das Programm schreiben. Sie möchten, dass der Code für diese Person einfach ist.
  2. 2 Nur weil eine Sprachfunktion in einer Sprache verfügbar ist, heißt das nicht, dass Sie sie verwenden sollten. Das Ziel ist es, zu kommunizieren, was der Code mit dem nächsten Leser macht, und ihn nicht zu beeindrucken, mit wie wenigen Zeilen man Code schreiben kann.
  3. 3 Oft ist ein Algorithmus schwer zu verfolgen. Aber oft wird es irgendwo veröffentlicht. Fügen Sie den URI der Dokumentation für den Algorithmus in den Kommentarabschnitt für den Code ein. Wenn der URI auf einen Ort verweist, der kurzlebig ist, kopieren Sie die Informationen an einer Stelle, an der der Code-Betreuer sie finden kann.
  4. 4 Referenzieren Sie den Codierungsstandard im Header der Datei. Stellen Sie nach Möglichkeit eine Datei bereit, die Tools öffnen kann, um die richtigen Einstellungen zu übernehmen. Als Beispiel verwendet Eclipse standardmäßig Tabs, aber Tabs werden in verschiedenen Texteditoren unterschiedlich dargestellt. Die Verwendung von Leerraum anstelle von Registerkarten ist möglicherweise vorzuziehen, jedoch mit einer Datei, die die richtigen Einstellungen für ein Projekt bietet.
  5. 5 Verwenden Sie Leerraum. Überspringen Sie Zeilen zwischen Code, der verschiedene Dinge ausführt, und verwenden Sie Leerzeichen nach Semikolons und Kommas. Dadurch wird Ihr Code sauberer und leichter lesbar.
  6. 6 In geschweifte Klammern einrücken. Dies macht es so, dass es offensichtlich ist, dass ein Stück Code von einem anderen getrennt ist. Dies kann beim Schreiben einer langen Methode hilfreich sein. Einrücken in, wenn Anweisungen und Schleifen das Lesen erleichtern. Diese Technik wird Verschachtelung genannt, das heißt, sie zeigt, dass ein Stück Code in einem anderen Stück Code "verschachtelt" ist, und ermöglicht es dem Leser, dem Verschachtelungsmuster leicht zu folgen.
  7. 7 Schreiben Sie beschreibende Kommentare. Angenommen, die Person, die Ihren Code liest, weiß nicht, was sie tun soll. Ihre Kommentare sollten jeden Schritt des Weges erklären. Alle Ihre fortgeschrittenen, verwirrenden oder komplizierten Algorithmen sollten gut kommentiert werden. Versuchen Sie auch, den Zweck des Codes zu beschreiben. Anstatt beispielsweise "add one to variable" zu schreiben, sagen Sie, warum dies im Code wichtig ist, da jeder sehen kann, dass die Variable inkrementiert wird, z. B. "die Anzahl der Seitentreffer um 1 erhöhen".
  8. 8 Machen Sie Ihren Code "selbstdokumentierend", indem Sie beschreibende Objektnamen erstellen, die ihre Ziele beschreiben. Objekte sollten entweder auf die Domäne des Problems oder auf Standardsoftware-Artefakte verweisen. Eine Liste ist eine Liste. Möglicherweise müssen Sie eine Kundenliste erstellen, die eine Liste unterklassifiziert oder implementiert. Variablen und Funktionsparameter sollten beschreibende Namen haben.
  9. 9 Fügen Sie den ursprünglichen Autor und den aktuellen Betreuer des Codes in den Anfangskommentar der Datei ein. Dies sagt den Leuten, wer zum Service gehen soll.
  10. 10 Kommentar oft. Schreibe Kommentare, um deine Absicht anzuzeigen. Wenn Sie Ihren Code kommentieren, wird jemand Ihre Kommentare löschen.