10 tipů pro psaní Cleaner & lepší kód

Programování je bezpochyby obtížné Jak se naučit programování bez stresu Jak se naučit programování bez stresu Možná jste se rozhodli programovat, ať už pro kariéru nebo jen jako koníček. Skvělý! Ale možná se začínáte cítit ohromeni. Není to tak skvělé. Zde je nápověda, která vám usnadní cestu. . Je to jedna věc, naučit se jazyky a studovat algoritmy, ale je to celá jiná bestie, která se snaží kódovat složitou pracovní aplikaci, která vás nutí nechat se vytrhnout z očí..

Svým způsobem je psaní čistého kódu hodně podobné kreslení, vaření nebo fotografování. 5 Kreativních koníčků, které z vás učiní šťastnější osobu 5 Kreativních koníčků, které vás učiní šťastnější osobou štěstí. Zde je několik kreativních koníčků, o kterých se prokáže, že tímto způsobem pomáhají. - vypadá to snadněji, než ve skutečnosti je. Tak proč se obtěžovat? Protože výhody stojí za to:

• Problémy se snadněji řeší. Jakmile začnete přemýšlet v čistém kódu, váš přístup ke změnám řešení problémů. Namísto řešení brutální síly se vaše algoritmy a softwarový design stávají elegantnějšími a úmyslnějšími.
• Méně času je zbytečné na údržbu. Čistý kód je lépe čitelný a srozumitelný, takže trávíte méně času zkoušením, co určité segmenty skutečně dělají, a více času na opravou, revizí, rozšířením atd..
• Nápady jsou jasněji sdělovány. Pokud pracujete s jinými programátory, čistý kód snižuje pravděpodobnost nedorozumění mezi vámi, což také z dlouhodobého hlediska znamená méně chyb.

Zde můžete začít psát čistý kód.

1. Použijte popisná jména

Co jsou proměnné, třídy a funkce? Existuje mnoho způsobů, jak na to odpovědět, ale když o tom opravdu přemýšlíte, tyto věci nejsou ničím jiným než rozhraním mezi programátorem a základní logikou aplikace..

Pokud tedy používáte nejasné a nepopisné názvy proměnných, tříd a funkcí, v podstatě zmatujete aplikační logiku od každého programátora, který čte kód, včetně sebe.

“Nejsem skvělý programátor; Jsem jen dobrý programátor se skvělými návyky.”
- Kent Beck

Co pojmenuje proměnná dxy ve skutečnosti znamená? Kdo ví. Pravděpodobně byste si museli přečíst celý kus kódu, abyste reverzně analyzovali jeho význam. Na druhé straně, význam proměnné jako distanceBetweenXY je okamžitě rozpoznatelné.

Totéž platí pro třídy a funkce. Neuspokojte se CalcTan () kdy můžete jít CalculateTangent () nebo CalcTangentAngle () místo toho.

2. Každému předmětu / funkci dejte jeden účel

Už jste někdy nahlédli do funkce, která byla dlouhá stovky nebo dokonce tisíce řádků? Pokud ano, pak víte, kolik bolesti může být při procházení, porozumění a úpravách. Komentáře mohou pomoci, ale pouze v omezené míře.

“Programování rozděluje jeden velký nemožný úkol na několik malých možných úkolů.”
- Jazzwant

Čistý kód je rozdělen na atomové kousky. Každá funkce by se měla zaměřit na jednu věc a každá třída by měla usilovat o reprezentaci jednoho konkrétního konceptu. Toto je samozřejmě zjednodušení, ale v případě pochybností je jednodušší čistší.

V praxi je složitý výpočet jako GetCreditScore () může být třeba rozdělit na několik pomocných funkcí, jako je GetCreditReports (), ApplyCreditHistoryAge (), a FiltrOutstandingMarks ().

3. Vymažte nepotřebný kód

Tento špatný zvyk je ten, se kterým stále občas bojuji. Obvykle se to děje takto: Chci opravit nebo optimalizovat kus kódu, takže to komentuji a přepisuji těsně pod ním - a přestože to funguje, starý kód tam ponechám jen pro případ.

“Je možné, že software není jako nic jiného, ​​že má být vyřazen: že celé je to vždy vidět jako mýdlovou bublinu?”
- Alan J. Perlis

Postupem času shromažďuji spoustu komentovaných bloků kódu, které již nepotřebujeme, ale zaplňují mé zdrojové soubory.. A zábavné je, že v mnoha případech se okolní kód vyvinul, takže kódovaný komentář nebude fungovat, i když bude obnoven.

Jde o to, že tato praxe komentování “záložní kód” byl zastaralý pomocí ovládání zdroje. Pokud nepoužíváte něco jako Git nebo Mercurial, musíte začít okamžitě používat ovládání zdroje Co je Git a proč byste měli používat kontrolu verzí Pokud jste vývojář Co je Git a proč byste měli používat kontrolu verzí, pokud re vývojář Jako weboví vývojáři hodně času máme tendenci pracovat na webech pro místní vývoj a poté, když jsme hotovi, vše nahrajeme. To je v pořádku, když jste jen vy a změny jsou malé,…. Čeká vás čistší kód.

4. Čitelnost> Chytrost

Příliš mnoho programátorů se spojí “čistý kód” s “chytrý kód”, jako by zhutnění deseti řádků do jedné bylo nějak čistší. Jistě, zabírá méně místa na obrazovce, ale je to vlastně snazší pochopit? Někdy možná. Ale většinu času? Ne.

“Každý ví, že ladění je v první řadě dvakrát tak těžké jako psaní programu. Takže pokud jste tak chytří, jak můžete, když to píšete, jak to vůbec odladíte?”
- Brian W. Kernighan

Myslím, že programátoři milují chytrý kód, protože to vypadá jako vyřešená hádanka nebo hádanka. Našli speciální a jedinečný způsob, jak něco implementovat - a “zkratka” pokud chcete - a téměř to funguje jako ověření dovedností programátora.

Ale abyste mohli psát čistý kód, musíte nechat své ego u dveří.

Vždy optimalizujte kód pro další osobu, která si ho přečte, protože s největší pravděpodobností bude další osobou ve skutečnosti VY a není nic hanebnějšího, než že nedokáže přečíst nebo pochopit svou vlastní chytrost..

5. Dodržujte konzistentní styl kódování

Nemám nic proti dobrým programovacím tutoriálům. Co dělá dobrý programovací výukový program? Co dělá dobrý programovací výukový program? Ne všechny programovací návody jsou rovnocenné. Některé z vás a ostatních nakonec ztratí čas. Zde je, co hledat v kvalitním programovacím tutoriálu. , ale jednou z nevýhod je to, že nováčci nakonec vyzvednou širokou škálu konfliktních zvyklostí, zejména pokud se týkají stylu kódování.

Nejsem tady, abych prohlásil, že jeden styl je lepší než jiný. Pokud chcete rovnátka na jejich vlastních linkách, jděte na to. Pokud chcete předcházet volání metod mezerami, dobře. Pokud dáváte přednost kartám před mezerami, nenechte se mě přesvědčit jinak.

Ale ať děláte cokoli, zůstaňte v souladu!

Krásná je lepší než ošklivá.
Explicitní je lepší než implicitní.
Jednoduché je lepší než složité.
Komplex je lepší než komplikovaný.
Byt je lepší než vnořený.
Řídké je lepší než husté.
Čitelnost se počítá.
- Tim Peters, Zen Pythonu

Pokud se chystáte použít camelCaseNaming pro proměnné, ne falšovat s podtržítko. Pokud používáte GetThisObject () na jednom místě, nechoď s FetchThatObject () někde jinde. A pokud kombinujete karty a mezery, zasloužíte si, aby byla vaše klávesnice odebrána.

Rozhodněte se, co budete dělat od samého začátku, a držte se ho skrz a skrz. Některé jazyky, například Python a C #, mají průvodce jazykovým stylem, který byste mohli chtít sledovat.

6. Vyberte správnou architekturu

Existuje mnoho různých paradigmat a architektur, které můžete použít k vytvoření vašich projektů. Všimněte si, jak tento tip je o výběru že jo jeden pro vaše potřeby, ne o výběru nejlepší jeden tam. Tady není žádný “nejlepší” tady.

“Bez požadavků a designu je programování způsob, jak přidat chyby do prázdného textového souboru.”
- Louis Srygley

Například vzor Model-View-Controller (MVC) je v současné době ve vývoji webových aplikací velmi populární, protože pomáhá udržovat kód uspořádaný a navržený tak, aby se minimalizovalo úsilí při údržbě..

Podobně je nyní ve vývoji her velmi oblíbený vzorec Entity-Component-System (ECS), protože pomáhá modularizovat herní data a logiku způsobem, který usnadňuje údržbu, a přitom vytváří kód, který je snadněji čitelný.

7. Zvládněte jazykové idiomy

Jedna z obtíží při zvládnutí nového programovacího jazyka 7 Užitečné triky pro zvládnutí nového programovacího jazyka 7 Užitečné triky pro zvládnutí nového programovacího jazyka Je to v pořádku, když vás učíme kódování ohromeni. Pravděpodobně zapomenete na věci tak rychle, jak se je naučíte. Tyto tipy vám mohou pomoci lépe si uchovat všechny nové informace. se učí nuance, které jej oddělují od všech ostatních jazyků. Tyto nuance mohou být rozdílem mezi ošklivým, spletitým kódem a krásným, snadno udržovatelným kódem.

Zvažte Python, Java a JavaScript. Všichni se od sebe navzájem velmi liší, do té míry, že to vyžaduje jiný způsob myšlení v závislosti na tom, který jazyk si zvolíte.

“Jazyk, který nemá vliv na způsob, jakým si myslíte o programování, nestojí za to znát.”
- Alan J. Perlis

Zatímco Python je hlavně o psaní kompaktních kódů a kachen, Java je spíše na straně výřečnosti a jednoznačnosti. Každý jazyk má idiomy (jako jsou seznamy s porozuměním v Pythonu), které podporují určitý způsob kódování. Dělali byste se dobře, abyste se je naučili.

Jsou tu také “anti-vzory” starat se o to, co jsou v podstatě suboptimální návrhové vzory, které vedou k neefektivnímu, nespolehlivému nebo jinak špatnému kódu. Studujte a odhaďte všechny běžné anti-vzory vztahující se k vašemu jazyku volby.

8. Prostudujte si Kodex mistrů

Pokud chcete psát čistý kód, nejlepší věcí, kterou můžete udělat, je zjistit, jak vypadá čistý kód, a pokusit se pochopit, proč to tak je - a neexistuje lepší způsob, jak to udělat, než prostudováním zdrojových souborů průmyslu mistři.

Je zřejmé, že nemůžete jen vyskočit do sídla společnosti Microsoft a podívat se na jejich projekty, ale vždy můžete procházet známé projekty s otevřeným zdrojovým kódem Jak zobrazit a upravit zdrojový kód aplikace s otevřeným zdrojovým kódem Jak zobrazit a upravit zdrojový kód O aplikaci s otevřeným zdrojovým kódem I když může být otevřený zdroj dobrým výběrem, budete také muset investovat do správné komunity. GitHub je jedním z nejlepších míst, jak toho dosáhnout, a to nejen kvůli pouhému množství… . Nevíte, kde začít? Vyzkoušejte prezentované projekty na Githubu.

“Každý blázen umí psát kód, kterému může počítač rozumět. Dobří programátoři píší kód, kterému lidé rozumějí.”
- Martin Fowler, Refaktoring: Vylepšení návrhu stávajícího kódu

Koneckonců, to je jeden z důvodů, proč existují open source projekty. Proč lidé přispívají k open source projektům? Proč lidé přispívají k projektům s otevřeným zdrojovým kódem? Open source vývoj je budoucnost softwaru. Je to skvělé pro uživatele, protože software s otevřeným zdrojovým kódem je obvykle k dispozici zdarma a často se bezpečněji používá. Co ale nutí vývojáře, aby přispívali kód zdarma? : aby se od nich mohli učit ostatní. A pokud se rozhodnete přispět k takovému projektu, může to urychlit proces učení. 5 Projektové nápady, které vám pomohou naučit se programování rychleji 5 Projektové nápady, které vám pomohou naučit se programování rychleji Existuje několik způsobů, jak uvolnit křivku učení pro programování. Znečistěte si ruce a učte se rychleji pomocí vedlejších projektů, které můžete začít kdykoli. Hrajte si s těmito pěti. .

Osobně jsem poprvé viděl opravdu čistý kód, když jsem narazil na nějaký open-source projekt Python s otevřeným zdrojovým kódem. Kód byl tak ohromující, že jsem téměř ukončil programování, ale nakonec mě to hodně naučilo.

9. Napište dobré komentáře

“Napište dobré komentáře” je nejstarší radou ve světě programování. Ve skutečnosti, jakmile se začátečníci seznámí s komentáři, jsou do značné míry povzbuzováni k tomu, aby komentovali tak často, jak jen mohou.

Skoro to ale vypadá, jako bychom se otočili příliš daleko opačným směrem. Zejména nováčci mají sklon k nadměrnému komentování - popisují věci, které není třeba popisovat, a chybí smysl toho, co “dobrý komentář” ve skutečnosti je.

“Vždy kód, jako by ten, kdo skončí udržováním vašeho kódu, bude násilný psychopat, který ví, kde žijete.”
- John Woods

Zde je dobré pravidlo: existují komentáře, které vysvětlují, proč existuje část kódu, spíše než CO vlastně kód skutečně obsahuje. Pokud je kód napsán dostatečně čistě, měl by být srozumitelný, co dělá - komentář by měl objasnit záměr, proč byl napsán..

Komentáře mohou být dobré pro varování (tj. “odstraněním tohoto se zlomí A, B a C”), ale z velké části by měly odhalit věci, které nelze okamžitě získat z kódu (tj. “použijte tento parametr, protože X, Y a Z”).

10. Refaktor, Refaktor, Refaktor

Stejně jako editace je součástí procesu psaní, refaktoring je součástí procesu kódování. Averze k refaktoringu je nejrychlejší způsob, jak skončit s neudržitelným kódem, takže v mnoha ohledech je to vlastně nejdůležitější tip, který je třeba zvážit.

Stručně řečeno, refactoring je jen fantastický termín pro vyčištění kódu, aniž by to ovlivnilo jeho skutečné chování.

“Kdykoli musím přemýšlet, abych pochopil, co kód dělá, zeptám se sám sebe, jestli dokážu změnit kód, aby bylo toto porozumění okamžitě zřejmé..”
- Martin Fowler, Refaktoring: Vylepšení návrhu stávajícího kódu

Jeden kousek moudrosti, který se na mě nalepil, je přísloví, “Nekomentujte špatný kód. Opište to.” Jak vysvětluje Fowler ve výše uvedené citaci, pokud se kód někdy cítí tak matoucí, že jej musíte komentovat, možná ho musíte skutečně změnit.

Kromě toho, jak upravujete kousky kódu sem a tam v průběhu projektu, vždy ponechte kód v lepším stavu, než když jste jej poprvé našli. V tuto chvíli se to může zdát jako nepříjemnost, ale v dlouhodobém horizontu se vyplatí (a dokonce může zabránit duševnímu vyhoření Programování Burnout: Jak znovu získat ztracenou motivaci Programování Burnout: Jak znovu získat ztracenou motivaci Napsání všech těchto řádků kód může být vyčerpávající fyzicky a emocionálně. Vše, co potřebujete, abyste se dostali zpět, je vědomí, že motivaci lze znovu získat.).

Naučit se vždy něco nového

Programátor, který se učí, jak psát čistý kód, se podobá romanopisci, který se učí, jak psát čistou prózu: neexistuje správný způsob, jak to udělat sám o sobě, ale existuje spousta špatných způsobů, jak to udělat, a bude to trvat let, aby zvládl.

Někteří lidé nemají to, co to znamená, a nakonec skončí s programováním pro dobré 6 známek, že nemáte na mysli být programátorem 6 Známky, že nemáte na úmyslu být programátorem Ne každý je vystřižen, aby byl programátorem. Pokud si nejste zcela jisti, že jste chtěli být programátorem, zde jsou některé náznaky, které vás mohou nasměrovat správným směrem. - a to je v pořádku, protože existuje spousta dalších technických úkolů, které nezahrnují kódování. Kódování není pro každého: 9 technických úkolů, které můžete získat bez něj Kódování není pro každého: 9 technických úkolů, které můžete získat bez něj nenechte se odradit, pokud chcete být součástí technologického oboru. Existuje spousta pracovních míst pro lidi bez kódovacích dovedností! .

Ale pro všechny ostatní je čistý kód něco, o co se absolutně vyplatí usilovat, i když se do něj dostanete po zbytek života.

Jak důležitý je pro vás čistý kód? Jaká pravidla dodržujete, aby byl váš kód čistý a organizovaný? Máte nějaké další kousky moudrosti? Dejte nám vědět v komentářích níže!