Entwicklungsparadigma durch Kommentieren

Ich wurde aufgefordert, dieses Konzept zu schreiben, weil ich bei einem neuen Projekt immer wieder auf ein Problem gestoßen bin: Während der 5-jährigen kommerziellen Entwicklung hatte ich ständig das „Glück“, zu einem Projekt zu kommen, das der leitende Entwickler verlässt. Und jedes Mal, wenn ich eine riesige Codebasis geerbt habe, wurden die Gesetze seiner Funktionsweise nur von seinem Schöpfer verstanden. Ich habe mir wiederum bereits nach dem ersten Jahr angewöhnt, mich durch Design und durch Kommentare zu entwickeln. Was ich Ihnen unter dem Schnitt mitteilen möchte:

Entwicklungsparadigma durch Kommentieren

Idee. Kommentar-Design. Code (IC-DC)

Idee: Gestalten durch Kommentare. Code

• Idee
  Der Initiator der Idee kann entweder Sie oder eine andere Person sein - zum Beispiel Ihre PM (TimLead).

Beispiel einer Idee: "Sie müssen die Telefonnummer aus Zeichen wie" + "," - "," eckigen Klammern "und" Leerzeichen "löschen, damit die Ausgabe nur aus einer Reihe von Zahlen besteht. Die Funktion wird benötigt, um eine Suche nach Telefonnummer durchzuführen - auf irgendeine Weise eingegeben."

• Gestaltung durch Kommentare
  Schreiben von Kommentaren, die die Logik des Programms beschreiben.

Designbeispiel durch Kommentare:

<?php namespace App\Services; use App\Entity\Users; use Doctrine\ORM\EntityManagerInterface; use Doctrine\ORM\EntityManager; class PhoneService { //  ,   //        //    //  ,    8,     7 //   } 

• Code schreiben
  Jetzt müssen wir unsere Kommentarprojektion in Code konvertieren:

Beispiel:

 <?php namespace App\Services; use App\Entity\Users; use Doctrine\ORM\EntityManagerInterface; use Doctrine\ORM\EntityManager; class PhoneService { //  ,   public function clear_phone(string $phone){ //        $symbols_for_delete = ['+','-','(',')', ' ']; //    $phone = str_replace($symbols_for_delete, '', $phone); //  ,    8,     7 if( $phone[0] == '8' ){ $phone[0] = '7'; } //   return $phone; } } 

Wofür ist es?

Warum brauche ich Kommentare, Code und so ist es klar?

Viele werden sagen, dass der Code der Text ist - und er ist leicht zu lesen. Und ich muss erwähnen, dass Code eine Methode ist, um Ihre Gedanken durch die Syntax der von Ihnen verwendeten Sprache auszudrücken. Und wenn wir komplexe Logik schreiben, verwenden wir unseren eigenen, in vielerlei Hinsicht einzigartigen Stil, um diese Syntax zu verwenden. Wenn wir uns jedoch in der Entwurfsphase befinden, beschreiben wir unsere Logik in einer allgemein akzeptierten Sprache und kehren nach 3 Jahren zum Code zurück, um zu verstehen, wie er funktioniert und wie unser Code funktioniert. Der Erbe kann es ebenso schmerzlos herausfinden. Verwenden von Design durch Kommentare - Reduziert die Entropie Ihres Projekts und verschönert den Code.

Warum brauche ich Design, kann ich mich hinsetzen und alles auf einmal schreiben?

Wenn Sie diese Frage stellen, müssen Sie nur dringend den " Perfect Code " von Steve McConnell lesen. Dort ist dieses Konzept mehr als offenbart.
Ich werde ein kleines Zitat geben:

In der Code-Design-Phase werden normalerweise 75% der Fehler gefunden. Wenn sie nicht gefunden würden, müsste ich umgestalten.

In der Entwurfsphase können Sie verstehen, dass die konzipierte Geschäftslogik nicht wie geplant funktioniert, oder Sie können einen besseren Ansatz zur Lösung eines bestimmten Problems erkennen. Und Sie müssen später nicht zurückkehren und ein Stück Logik umgestalten - was nicht genau so funktioniert, wie es beabsichtigt ist.

Muss ich alles kommentieren?

Ich habe oben elementare Beispiele gegeben. Sie sind vollständig verständlich und kommentarlos, aber ich habe immer noch den IC-DC-Ansatz verwendet, um sie zu implementieren. Weil Ich möchte nicht, dass mein Code entropisch wird. Ich habe viele Projekte besucht, bei denen die meisten Projekte gerade wegen der enormen Entropie von Grund auf neu geschrieben werden mussten. Überlegen Sie, ob das Projekt, das Monate oder Jahre Ihres Lebens verbracht hat, einfach gelöscht werden soll. Wenn die Antwort nein ist, dann denke ich, lohnt es sich immer, diesen Ansatz zu verwenden. Weil Wenn Sie das Projekt verlassen oder ein paar Jahre später eine neue Technologie auftaucht, die die Anforderungen besser abdeckt als Ihre alte Lösung - IC-DC hilft Ihnen dabei, die Änderungen optimal umzusetzen und das Minimum an Funktionalität zu erreichen, da ein neuer Mitarbeiter oder ein neuer Mitarbeiter versteht, wie und warum dies funktioniert.