Stellen Sie sich eine einzige Sache vor, die Ihren Code verständlicher macht und Ihnen hilft, den Code eines anderen viel einfacher zu verstehen, und Sie werden den Code eines anderen, der vor Ihrem Eintritt in das Unternehmen geschrieben wurde, weniger „durcheinander bringen“. Und das Beste ist, Sie werden immer verstehen, ob es sich lohnt, es zu ändern oder besser, es nicht zu berühren. Präsentiert ?!
Der Anfang ist zu vielversprechend und Sie haben bereits eine Art Scheidung gespürt.
Nun im Ernst.
Ich schreibe Code sowohl für mich selbst in meinem eigenen Projekt als auch in einer Firma, in der ich mehr als eine programmiere. Und ich bemerkte, dass selbst wenn ich alleine arbeite und zum alten Abschnitt des Codes zurückkehre, Gedanken auftauchen: „Warum habe ich hier so geschrieben, ist das falsch?“ Und plötzlich, wenn ich mich ändern möchte, kann die Situation entstehen, dass jetzt etwas falsch funktioniert und die Entscheidung, die ich getroffen habe, als ich diesen alten Code geschrieben habe, optimal war.
Daher ist es wichtig, in den Kommentaren „Warum“, „Warum habe ich diese Entscheidung beim Programmieren getroffen?“, „Warum habe ich aus allen Optionen genau die Implementierung ausgewählt, bei der ich aufgehört habe?“ Zu schreiben. Vor allem, wenn Sie in einem Team arbeiten. Ich hatte die Situation, dass der Code, den eine andere Person geschrieben hat, nicht vollständig implementiert hat, was ich brauchte, und jetzt habe ich eine logische Frage: "Warum hat er das getan?", Aber wir können uns nicht an alles erinnern und haben logischerweise die Antwort erhalten: " Ich kann mich nicht erinnern warum. Dort ist etwas nicht zusammengewachsen. " Und Sie befinden sich in einer Pattsituation, der Option, die jetzt verfügbar ist, und haben andererseits Angst, Sie neu zu schreiben, weil Sie nicht wissen, woher das Problem kommt, vielleicht stoßen Sie auf dasselbe unlösbare Problem, mit dem Ihr Kollege konfrontiert war, oder vielleicht auch nicht . Wer weiß das jetzt ?! Und dies führt dazu, dass einige Teile des Codes „unantastbar“ werden und Sie Angst haben, sie zu berühren.
Ich glaube also, dass das Schreiben des Grundes für die Wahl einer Option bestimmte Boni bringt.
- Selbst wenn Sie alleine arbeiten, können Sie sofort verstehen, ob Sie den Grund kennen. Sie sind gerade dumm geworden, als Sie diesen Code geschrieben haben, oder es ist angesichts des Kontexts ein angemessener Code.
- Sie wachsen als Programmierer auf und können die Entscheidung, die Sie einmal aus Unerfahrenheit getroffen haben, ändern, weil Sie wissen, warum sie hier ist.
- Mit der Zeit kann der Grund, warum ein solcher Code geschrieben wird, in Vergessenheit geraten. Wenn Sie dies jetzt sehen, verstehen Sie, dass Sie sich mit einem ruhigen Geist davon trennen können. Wenn Sie ihn nicht schreiben, bleibt er hier. Angst, etwas zu verletzen.
- Sie können den alten Code, der vor Ihnen geschrieben wurde, auf eine neue Weise betrachten. Wenn Sie ihn früher mit einem arroganten Blick nur beschimpft haben, verstehen Sie jetzt, dass dies in der Situation, in der sich die Programmierer vor Ihnen befanden, eine sehr richtige Entscheidung war.
- Spart die Situation beim Reinigen, die Krückenentscheidung, die vor Ihnen lag, und es stellt sich heraus, dass Sie die Büchse der Pandora geöffnet haben, weil nur diese Krücke vom universellen Tod abgehalten wurde.
- Wenn Sie schreiben, warum, kann ein anderer Entwickler, der dies sieht, neu schreiben und wissen, wie Sie das von Ihnen gelöste Problem effektiver lösen können.
Abschließend möchte ich sagen. Der Code bleibt für eine lange Zeit gedruckt, aber die Gedanken und Gründe der Menschen, die zu einem bestimmten Zeitpunkt in einer bestimmten Situation genommen wurden, um am nächsten Tag zu verdampfen.