Free Press

Vítejte v úžasném světě vývoje softwaru. Připravte se na vzrušující a napínavou cestu plnou kódu, pravidel a dalšího kódu. A už jsem zmínil, že existují pravidla? Pokud patříte k lidem, kteří jsou obeznámeni s kódováním, pak pro vás pojem kódovací standardy není ničím novým. Možná jste silným zastáncem těchto pravidel nebo bojovníkem za svobodu, který věří, že kód je formou vyjádření. Ať už je to jakkoli, není na škodu podívat se na některé osvědčené postupy, pokud jde o psaní dobrého kusu kódu.
Je třeba zmínit, že ačkoli standardy kódování existují – existují v mnoha variantách a často se jedná pouze o pokyny, které není nutné dodržovat. Pokud nechcete psát dobrý kód, pak byste se pravděpodobně měli nějaké formy standardů držet.

Pište komentáře a dokumentaci

Možná jedna z prvních věcí, kterou se jako vývojář naučíte, je komentovat kód. Zpočátku se to může zdát jako ztráta času, řídící se mentalitou „Když jsou taky vývojáři – tak tomu rozumí“. I když je to v některých případech pravda, komentování vašeho kódu a poskytnutí řádné dokumentace provede ostatní vývojáře algoritmem a logikou, kterou jste implementovali. Nenechte se však unést a nekomentujte každý řádek kódu! Zřejmý kód by měl zůstat tak, jak je.

Pište čitelný, ale efektivní kód

Čitelný kód je snadno sledovatelný, přitom optimálně využívá prostor a čas. Při psaní kódu můžete často chtít napsat kód na co nejmenší počet řádků. Možná můžete napsat celou metodu nebo funkci na jeden řádek, ale tím jen ztížíte její čtení a pochopení.

Používejte pomocné metody

Je dobrým zvykem udržovat kód stručný a výstižný. Metoda by měla implementovat pouze to, co potřebuje udělat. Pokud část implementace dělá něco jiného, vložte ji do samostatné metody a volejte ji v rámci své metody.

Pokud se tomu dá vyhnout, NEKÓDUJTE natvrdo!

Jediné věci, které by se měly kódovat natvrdo, jsou konstanty. To je vše.

Pište testovací případy. Nezapomeňte na okrajové případy:

Tak budete vědět, co vaše metoda dělá, co bere a co má vracet. Budete vědět, kdy by měla fungovat a kdy by měla selhat. Funkce by měla být vždy založena na testovacích případech; ne na testech funkcí.

Pište čitelný, ale efektivní kód. dodržujte standardy kódování aktuálního projektu

„DISCIPLINOVANÉ OSOBNÍ PRAKTIKY MOHOU SNÍŽIT ÚROVEŇ CHYB až o 75 %“

Každý projekt/firma má své vlastní standardy kódování. Některé mohou upřednostňovat jeden styl před druhým, pokud jde o takové věci, jako jsou konvence pojmenování, struktura souborů a mezery.
Existují IDE, kde můžete nastavit preferovaný styl, který se vám při ukládání automaticky opraví. Je snazší číst, a tedy i pochopit, když všechny soubory projektů používají stejný styl, konvenci pojmenování, mezery atd.

Používejte rozbalovací nabídku svého IDE

Není to ani tak standard, ale dobrá praxe, jsou velmi užitečné a pomohou vám udělat méně chyb při kódování.

Například:
Pokud chcete přejmenovat proměnnou nebo metodu, stačí použít možnost „refactor“ vašeho IDE a to změní všechna volání dané metody/jméno proměnné. Nemusíte je měnit jedno po druhém, což způsobí, že váš kód bude náchylný k chybám/chybám.
Pokud chcete vytvořit getter/setter metody všech svých soukromých proměnných, stačí použít „create getter/setter“ a IDE automaticky vytvoří metody za vás.

API jsou šikovné

„SOUČASNÉ SOFTWAROVÉ PROJEKTY VYDĚLAJÍ PŘIBLIŽNĚ 40 až 50 PROCENT SVÉHO ÚSILÍ NA ODSTRANITELNOU PRÁCI“

Před implementací metody se ujistěte, že není k dispozici, abyste ji mohli použít. Nemusíte kódovat, pokud můžete danou funkci pouze importovat. Vývojáři to mimořádně usnadní život.
Známé rčení zní „Nevymýšlej znovu kolo“ a v mnoha případech platí. Vždy byste však měli zvážit důsledky importu knihovny, zejména pokud se jedná o knihovnu třetí strany. Kromě možných licenčních problémů můžete jen nafouknout svou kódovou základnu. Pokud potřebujete pouze metodu, která převádí teploty, nemusíte importovat knihovnu, která to dělá a stovky dalších věcí.“

Párování programování/revize kódu

„PEER REVIEWS CATCH 60 PERCENT OF THE DEFECTS“

Ty jsou velmi užitečné, pokud jde o refaktorizaci vašeho kódu. Ostatní mohou vidět lepší implementaci pro optimalizaci vašeho kódu nebo jen udělat váš kód elegantnější. Zajišťuje také, že vývojáři dodržují standardy a práce je dvakrát kontrolována. Kromě toho všeho je to pro vývojáře skvělý způsob, jak se učit jeden od druhého.

ZÁLOHUJTE A UCHOVÁVEJTE SVOU PRÁCI ČASTO

To už bylo řečeno. Vybitá baterie, výpadek proudu, softwarová závada, požár, jaderná katastrofa – to vše může mít za následek ztrátu dat. Zajistit časté ukládání a zálohování kódu v nějakém systému správy verzí je jednoduchý způsob, jak zajistit, aby váš kód zůstal v bezpečí.

Standardy kódování a osvědčené postupy jsou rozsáhlým tématem – tématem, které by vydalo na mnoho stránek. Ve skutečnosti, pokud si někdy budete chtít přečíst něco o standardech kódování v jazyce Java, má společnost Oracle právě tuto nabídku. Aplikace těchto standardů a postupů se také liší podle použití – ať už pracujete na obrovském firemním projektu, nebo pomáháte malému bratrovi s domácími úkoly. Na základě mnoha faktorů je nakonec na vás, abyste se ujistili, že kód, který vyvíjíte, je dobrý kód.

Odmítnutí odpovědnosti: Veškeré názory a stanoviska prezentované v tomto příspěvku na blogu jsou výhradně názory autora a nemusí nutně vyjadřovat názory společnosti Aversan Inc.

.