poniedziałek, 24 października 2016

Pisz czytelny kod! Używaj komentarzy w kodzie.

Każdy początkujący programista, webmaster, który tworzy program bez względu jaki jest, czy mały, czy duży, robi podstawowe błędy podczas pisania aplikacji. Nie chodzi mi o nazewnictwo zmiennych, bo musiałbym pisać o wielu językach programowania, ale o pisaniu samego kodu.
Nie ważne, czy tworzysz program w C++, C#, Java lub w czystym HTML'u. Ważne jest, aby pisać kod, który będzie czytelny i opisywał to, co dany kod robi.
Sam kiedyś robiłem błędy podczas pisania programu w C++ jak i też w HTML, a błąd był następujący:

 <html>   
 <head> 
 </head>
 <body>
 <div class="nazwa klasy">
 if(x==y){
 echo "Liczba X jest taka sama co Y";
 }
 </div>
 </body>     
 </html>

Jak widać w powyższym kodzie, nie ma wcięć i nie jest czytelny. Dlatego, jeżeli zabierasz się za pisanie kodu, to rób wcięcia!
Aby kod był bardziej czytelniejszy, zawsze przy danej funkcji lub kodzie, który wykonuje dane zadanie, pisz komentarz. Można na dwa sposoby pisać komentarze:
  • jednowierszowe, zaczynające się od //
  • wielowierszowe , zaczynające się od /*   kończący się na */
Jeżeli chodzi o sam html, to można dać inny sposób komentowania <!-- komentarz -->
Dobra a jak powinien wyglądać prawidłowo napisany kod, który jest powyżej?

 <html>   
          <head>
          </head>
        <body>
            <div class="nazwa klasy">
               if(x==y){
                echo "Liczba X jest taka sama co Y";
              }
            </div>
        </body>     
 </html>

Widać różnicę, prawda? To jest tylko prosty przykład.
Pamiętaj, jeżeli nie zadbasz  o jakość kodu i o porządek w kodzie, to sam pogubisz się a tym bardziej, jeżeli nie będziesz pisać komentarzy, co za co odpowiada. Doprowadzisz do tego, że będziesz musiał od zera napisać aplikację.