Zobrazit příspěvky
1
Vývoj / Re:Zlepšení čitelnosti vlastního kódu
« kdy: 31. 05. 2021, 11:40:02 »
Naštěstí pro mě, když se ke svému kódu vracím, tak se velmi rychle zorientuji v tom co dělá. Kolegové si mi nikdy nestěžovali, naopak mám i zpětnou vazbu, že můj kód se čte příjemně. Uvedu za sebe pár tipů co mě teď napadají z hlavy a není to na slohovou práci.
1. Proměnné vždy nějak výstižně pojmenovat i když to může být dlouhé. Včetně dočasných proměnných ve foreach loopech apod.
To už tu sice padlo, ale chtěl jsem zdůraznit že je třeba je používat opravdu všude. Vždycky miluju, když prolítávám něčí vesměs čitelný kód a vidím tam pak něco takového (viz. příklad). Místo toho abys to prolítl, tak pak vyšetřuješ co tam asi tak může být.
Špatně:
Lépe:
2. Komentáře
Shrnující - Aby člověk pochopil co kód dělá bez toho aniž by ho vůbec četl. U větších projektů k nezaplacení - jdeš prostě po komentářích a neluštíš nic. Čteš to jako knihu
.
Technické - komentáře k fungování samotného kódu.
Příklad (všimni si, že vůbec nepotřebuješ vidět kód a vidíš co se děje):
1. Proměnné vždy nějak výstižně pojmenovat i když to může být dlouhé. Včetně dočasných proměnných ve foreach loopech apod.
To už tu sice padlo, ale chtěl jsem zdůraznit že je třeba je používat opravdu všude. Vždycky miluju, když prolítávám něčí vesměs čitelný kód a vidím tam pak něco takového (viz. příklad). Místo toho abys to prolítl, tak pak vyšetřuješ co tam asi tak může být.
Špatně:
Kód: [Vybrat]
foreach($values as $k => $v){Lépe:
Kód: [Vybrat]
foreach($persons as $name => $age){2. Komentáře
Shrnující - Aby člověk pochopil co kód dělá bez toho aniž by ho vůbec četl. U větších projektů k nezaplacení - jdeš prostě po komentářích a neluštíš nic. Čteš to jako knihu
.Technické - komentáře k fungování samotného kódu.
Příklad (všimni si, že vůbec nepotřebuješ vidět kód a vidíš co se děje):
Kód: [Vybrat]
# assign variables
...
.
$data = json_decode($_POST['data'],true); # true - get json string into array not object (technicky komentar k prepinaci, aby si nemusel listovat dokumentaci a zjistovat co to dela)
.
...
# verify input
...
.
.
...
# errors detected - return 400 bad request
...
.
.
...
# no errors - put values into DB, return 200 ok
...
.
.
...
. Na výšce to bylo samý párek a dávali nám takový záhul, že na nějaké blbosti ani nebyl čas 
.
.