CleanCode elv az lényegeben ez?
Hangzatos változónevek.
OOP-elv.
Megfelelő kód tördelés
Kiegészitő kommentek
OOP nem része, mert pl. Go vagy C nyelvben nincs objektum orientáltság, még is szép, ha rendezett a kód.
CleanCode az lényegében egy-több kód formázási-tördelési-szerkezeti játék, amik segítenek átlátni a kódot, és nem keresgélni kell az elejét és végét.
Nincs kőbe vésett szabály. Csapatonként eltérő lehet bizonyos szabály, hogy ki hogyan alkalmazza és akkor ott úgy kell alkalmazni.
Szokszór láttam olyat, hogy kiegészítő kommenteket nem is alkalmaznak (én is ritkán), mert ha van, akkor minden változás után módosítása áll fent. Ekkor elő fordulhat, hogy párat elfelejtesz, és másnak zavaró lehet, hogy mást csinál a kód, mint amit a comment ír.
Ekkor, ha nem írsz kommenteket, akkor a kódnak kell tudnia mesélni magáról, hogy ő mit csinál. Azaz a programkód önmagát dokumentálja.
#1 "Ekkor, ha nem írsz kommenteket, akkor a kódnak kell tudnia mesélni magáról, hogy ő mit csinál. Azaz a programkód önmagát dokumentálja."
Igen, és ilyenkor szoktak fél képernyősor hosszú változónevek lenni, amik lehet, hogy "önmagukat dokumentálják", de az egész kód ocsmány lesz. Enyhén szólva is túllihegett ideológiának tartom a komment-ellenességet.
A CleanCode, ahogy a neve is takarja, a kód "tisztaságára", az átláthatóságra vonatkozik, hogy legyen egy formája, egy megfelelő tagolása az egésznek, és ne úgy kelljen bogarászni, hogy most mi mihez tartozik. Hol kezdődik egy ciklus, és hol fejeződik be. Tehát inkább a vizuális megjelenítés, mintsem a gyakorlati elemek.
Itt van néhány oldal, ami ezekben segít: [link]
De akár a Visual Studio-n belül is van egy csomó bővítmény erre a célra.
#6: manapság minden szarról könyvet írnak, nem releváns ebből kiindulni.
De hogy a nagy "szakértők" is értsék, miről szól a CleanCode (ha már ők maguk nem fejtették ki): "Code is clean if it can be understood easily – by everyone on the team. Clean code can be read and enhanced by a developer other than its original author. With understandability comes readability, changeability, extensibility and maintainability."
Tehát a programkód attól lesz tiszta (clean), hogy a saját készítőjén túl más fejlesztők is egyszerűen tudják majd értelmezni, egyértelmű lesz számukra. És ez valóban nem csak a kód tagolását, formázást foglalja magában (de azt IS), hanem a lekódolás minőségét is.
Azért ennél több.
pl.:
-KISS: Keep It Simple Stupid.
-DRY: Don't Repeat Yourself
-YAGNI: You Aren't Gonna Need It.
-Composition over inheritance
-Readability
Ha konkrétan rendszer tervezésről beszélünk nem csak egy kisebb funkció implementásáról, akkor még bejön egy rakat tervezési minta.
Az oop nincs clean kódhoz kötve.
A kommentelés meg kifejezetten a clean code ellen van. Alap esetben nem szabad kommentelni, hanem úgy kell megírni a kódot, hogy ránézésre egyszerűen olvasható legyen mit is akar. A kommenteket többnyire apró változtatások után nem updetelik és elveszi a figyelmet, így kerülni kell őket.
Maximum speciális esetben kell magyarázó jelleggel írni kommentet, ami ránézésre nem egyértelmű.
9# Jó, azt lehet, hogy te ezt csinálod, de nomális projecteken munkakörnyezetben nincsenek kommentek.
Elhiszem, hogy neked otthon ez működik és jó, de attól még a clean code ez ellen megy, sőt ha olvastad Robert C. Martin Clean Code könyvét, akkor tudhatod, hoyg az 53. oldaltól kokrétan indul egy 20 oldalas fejezet csak a kommentelésről, ahol ezt írja.
(Most gyors előkaptam a könyvet)
Kapcsolódó kérdések:
Minden jog fenntartva © 2024, www.gyakorikerdesek.hu
GYIK | Szabályzat | Jogi nyilatkozat | Adatvédelem | Cookie beállítások | WebMinute Kft. | Facebook | Kapcsolat: info(kukac)gyakorikerdesek.hu
Ha kifogással szeretne élni valamely tartalommal kapcsolatban, kérjük jelezze e-mailes elérhetőségünkön!