O'Reilly logo

Bash. Receptury by Cameron Newham, JP Vossen, Carl Albing

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

5.3. Zachowanie czytelności skryptu

Problem

Skrypt powinien być możliwie jak najbardziej przejrzysty, gdyż łatwiej się go wówczas analizuje i modyfikuje.

Rozwiązanie

  • Skrypt powinien być dokumentowany w sposób opisany w „5.1. Dokumentowanie skryptu”, oraz w „5.2. Osadzanie dokumentacji w treści skryptu”.

  • Należy z rozwagą stosować znaki odstępu wcinające tekst i puste wiersze.

  • Nazwy zmiennych powinny mieć opisowy charakter.

  • Warto stosować funkcje, nadając im opisowe nazwy.

  • Znaki przejścia do następnego wiersza powinny być wstawiane w odpowiednich miejscach, po mniej niż 76 znakach.

  • Najistotniejsze fragmenty kodu powinny znajdować się na początku wiersza.

Analiza

Dokumentowanie kodu oznacza opisywanie przeznaczania danego bloku skryptu, a nie pojedynczych ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required