749

15. Styl Kodowania

750

Rozdział ten dokumentuje styl kodowania używany w systemach live.

751

15.1 Kompatybilność

752

• Nie wolno używać składni lub semantyki, które jest unikalne dla basha. Na przykład, użycie układu konstrukcji.

753

• Nie używaj podzbiorów POSIX'a - na przykład, używaj $(foo) zamiast`foo`.

754

• Możesz sprawdzić swoje skrypty używając 'sh -n' i 'checkbashisms'.

755

• Upewnij się, że cały kod powłoki działa z 'set-e'.

756

15.2 Wcięcia

757

• Zawsze używaj tabulatorów zamiast spacji.

758

15.3 Zawijanie

759

• Generalnie linie mają maksymalnie 80 znaków.

760

• Używaj zakończeń lini "typowych dla Linuxa":

761

Źle:

762

if foo; then
         bar
fi

763

Dobrze:

764

if foo
then
         bar
fi

765

• To samo dotyczy funkcji:

766

Źle:

767

Foo () {
         bar
}

768

Dobrze:

769

Foo ()
{
         bar
}

770

15.4 Zmienne

771

• Zmienne występują zawsze zapisane drukowanymi literami.

772

• Zmienne wykorzystane w live-build zawsze zaczynają się przedroskiem LB_.

773

• Wewnętrzne tymczasowe zmienne w live-build należy rozpocząć od przedrostka _LB_.

774

• Lokalne zmienne zaczynają się przedrostkiem live-build' a __LB_.

775

• Zmienne dotyczące parametrów startowych live-config zaczynają się od LIVE_.

776

• Wszystkie inne zmienne w live-config zacznij przedroskiem _.

777

• Używaj nawiasów wokół zmiennych; na przykład napisz ${FOO} zamiast $FOO.

778

• Zawsze chroń zmienne znakami cytatu do zachowania potencjalnych białych znaków: napisz "${FOO}", a nie ${FOO}.

779

_ * Dla zachowania spójności, należy zawsze używać znaków cytatu podczas przypisywania wartości do zmiennych:

780

Źle:

781

FOO=bar

782

Dobrze:

783

FOO="bar"

784

• Jeśli zastosowane jest wiele zmiennych, przytocz całe wyrażenie:

785

Źle:

786

if [ -f "${FOO}"/foo/"${BAR}"/bar ]
then
         foobar
fi

787

Dobrze:

788

if [ -f "${FOO}/foo/${BAR}/bar" ]
then
         foobar
fi

789

15.5 Różne

790

• Używaj "|" (bez otaczających wyrażenie znaków cytatu) jako rozdzielacz w zapytania do sed'a, np. "sed -e 's|foo|bar|'" (bez "").

791

• Nie używaj komendy test dla porównań i testów, użyj "[" "]" (bez ""); np. "if [ -x /bin/foo ]; ..." a nie "if test -x /bin/foo; ...".

792

_ * Użyj case gdzie to jest możliwe zamiast test, jest to łatwiejsze do odczytania i szybsze w wykonaniu.

793

• Użyj nazw funkcji pisanych wielkimi literami, aby ograniczyć niepożądane działanie e środowisku użytkownika.