aboutsummaryrefslogtreecommitdiffhomepage
path: root/markup/pod/live-manual/media/text/pl/project_coding-style.ssi
blob: 7c90dcaf80f14cd49008b0298581f854ef0ae919 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
:B~ Styl Kodowania

1~coding-style Styl Kodowania

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

2~ Kompatybilność

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

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

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

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

2~ Wcięcia

_* Zawsze używaj tabulatorów zamiast spacji.

2~ Zawijanie

_* Generalnie linie mają maksymalnie 80 znaków.

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

Źle:

code{

 if foo; then
         bar
 fi

}code

Dobrze:

code{

 if foo
 then
         bar
 fi

}code

_* To samo dotyczy funkcji:

Źle:

code{

 Foo () {
         bar
 }

}code

Dobrze:

code{

Foo ()
 {
         bar
 }

}code

2~ Zmienne

_* Zmienne występują zawsze zapisane drukowanymi literami.

_* Zmienne wykorzystane w live-build zawsze zaczynają się przedroskiem
#{LB_}#.

_* Wewnętrzne tymczasowe zmienne w live-build należy rozpocząć od
przedrostka #{\_LB_}#.

_* Lokalne zmienne zaczynają się przedrostkiem live-build'a #{\_\_LB_}#.

_* Zmienne dotyczące parametrów startowych live-config zaczynają się od
#{LIVE_}#.

_* Wszystkie inne zmienne w live-config zacznij przedroskiem #{_}#.

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

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

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

Źle:

code{

 FOO=bar

}code

Dobrze:

code{

 FOO="bar"

}code

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

Źle:

code{

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

}code

Dobrze:

code{

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

}code

2~ Różne

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

_* 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;
...}#".

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

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