Formatowanie kodu PHP

Natomiast instrukcja return z linii 950 zwracająca wynik działania funkcji call_user_func_array() może zostać zapisana jako:

[+]

[-]

 

 

PHP

 1. return call_user_func_array(
 2.     $this->cache_handler_func,
 3.     array(
 4.         'clear',
 5.         &$this,
 6.         &$dummy,
 7.         $tpl_file,
 8.         $cache_id,
 9.         $compile_id,
10.         $exp_time
11.     )
12. );

Listing zwinięty - 12 linii

W analogiczny sposób sformatuj wywołanie funkcji smarty_core_write_compiled_include() w linii 1421 (oryginalna linia ma niemalże 200 znaków długości) - listing 6.

[+]

[-]

Listing 6. Wywołanie funkcji smarty_core_write_compiled_include()

Listing 6. Wywołanie funkcji smarty_core_write_compiled_include()

PHP

 1. smarty_core_write_compiled_include(
 2.     array_merge(
 3.         $this->_cache_include_info,
 4.         array(
 5.             'compiled_content' => $_compiled_content,
 6.             'resource_name'    => $resource_name
 7.         )
 8.     ),
 9.     $this
10. );

Listing zwinięty - 10 linii

Długie warunki instrukcji if czy while możesz zapisywać, stosując konwencję:

[+]

[-]

 

 

PHP

1. if (
2.     ...
3. ) {
4.     ...
5. } else {
6.     ...
7. }

Listing zwinięty - 7 linii

Linia 1694 po zastosowaniu powyższego rozwiązania przyjęłaby postać pokazaną na listingu 7.

[+]

[-]

Listing 7. Sposób na długie warunki instrukcji if lub while

Listing 7. Sposób na długie warunki instrukcji if lub while

PHP

1. if (
2.     ($string{0} == "'" || $string{0} == '"')
3.     && $string{strlen($string)-1} == $string{0}
4. ) {
5.     return substr($string, 1, -1);
6. } else {
7.     return $string;
8. }

Listing zwinięty - 8 linii

Podsumowanie

Trud włożony w przyzwyczajenie się do zasad formatowania kodu PHP, opisanych w dokumentacji biblioteki PEAR, z pewnością się opłaci. Na format kodu warto zwrócić uwagę od początku nauki języka. Unikniesz wtedy konieczności przestawiania się z jednego formatu na inny.

Jeśli którąkolwiek z zasad uznasz za zbędną lub zechcesz stosować własne wypracowane rozwiązanie, pamiętaj o zachowaniu spójności i konsekwencji.

Nazewnictwo w programach komputerowych stanowiło podstawę rozprawy doktorskiej Charlesa Simonyi'ego pt. "Meta-Programming: A Software Production Method". Praca ta ustanowiła szeroko rozpowszechniony standard nazewniczy znany jako notacja węgierska. Jest ona dostępna na stronach MSDN pod adresem: http://msdn.microsoft.com/libr....

Szerszy opis adresów URL, w tym wspomnianych example.org, znajdziesz natomiast w dokumencie RFC 2606 pt. "Reserved Top Level DNS Names".

Zgłębiając formatowanie kodu w językach, opartych o składnię języka C, warto odwiedzić witrynę programu astyle: http://sourceforge.net/project.... Służy on do automatycznego przeformatowania kodu programu w języku C. Z dołączonej dokumentacji dowiesz się o różnych stylach formatowania programów w języku C.

Ćwiczenia przedstawione w artykule są dostępne na stronie domowej autora pod adresem http://www.gajdaw.pl.