Hogyan kell olvasni a kódot 8 elvek érdemes megjegyezni - blog
A kódot a képernyőn lát, lehetett volna írta több ember. Talán ebben a folyamatban a vita és az együttműködés. Talán vette őket hétig kiadni egy kódot, amely megkerüli néhány dokumentált korlátozásokat, hogy nem tudja, és ez a tudás maradt csak a fejében, akik írta.
Minden, amit látsz, mint egy olvasó - a kész terméket. És ha nem költenek ásatásokat, az egyetlen kontextust, amelyben a munka - ez a kód a képernyőn.
1. Ismerje meg ásni
Amikor először megismerni a főbb codebase, talán akkor nem érzem a fejlesztő. Inkább úgy fogja érezni, régész egy magánnyomozó vagy kutató vallási könyveket. Ez teljesen normális, mert az Ön rendelkezésére számos eszközt „ásni”. Ha szerencsénk van, és a elődei használt verzió ellenőrzése, érdemes ünnepli! Van hozzáférése rengeteg metaadat, és nagyon sok elősegíti a megértést a környezetet, amelyben a kód jött létre. Továbbá azt is feltételezik, hogy a Git, de abban az esetben a SVN, minden lesz azonos.
Használja ezt a parancsot, hogy a történelem arra vállalkozik az egész tár. Ez a parancs megjeleníti a elkövetni üzenetet, és grep parancs segíthet megtalálni egyedi szöveget az elkövetni, mint ahogy a neve is someFunction funkció: git log | grep someFunction C3 (utolsó zászló megmutatja a kifejezést három sornyi kontextusát.)
2. Vissza a múltba
Meg lehet váltani, hogy bármilyen szervezet, és működteti a projekt, mintha az utolsó elkövetni. Szükség lehet váltani a commit ez volt az utolsó eljövetele előtt néhány nehéz követni a problémát. Vagy talán csak unatkozni, és azt szeretnénk, hogy ásni a történelem a kódot, és látom, hogy a projekt előtti években jött oda.
Amennyiben a projekt tárolt GitHub vagy hasonló szolgáltatást, akkor kap egy csomó információt, olvasás jegyek, pull-rekvest és code-felülvizsgálat. Ügyeljen arra, hogy a jegyeket, ami a legtöbb vitát. Lehet, hogy egy „fájdalom pontok”, hogy esetleg a jövőben szembesülhet, ezért jó, hogy előre kell elkészíteni.
5. Keresse meg a Main
Ez nyilvánvalónak tűnhet, de az első és legfontosabb, győződjön meg róla, hogy érti, amikor a kód elkezdi végrehajtani, és mi történik az indítás során. Lásd mely fájlokat tartalmazza, amely osztályok példányai, milyen config beállítást választotta.
A legvalószínűbb, akkor folyamatosan szembesülnek, és a többi kódot. Néhány modul csak nagyon általános célú, és kiemelkedik a többi kódot. Ezek a kisebb és egyszerűbb darabok szolgáltatással, amellyel tisztában kell lennie, mielőtt megpróbálja kezelni az összes alkalmazás teljesen.
Kövesse git hibáztatni ezt a fájlt, és mi részei a fő fájl megváltozott az utóbbi időben. Legutóbb módosított kódját lehet mondani, hogy milyen problémák a csapat dolgozott az elmúlt években. Talán egy új könyvtárat, vagy már régóta próbált egy könyvtár, amely nem működik túl jól. Vagy talán van néhány boylerpleyt kódot kell rendszeresen frissíteni.
Próbáld megtalálni hivatkozásokat a modulok más részein a kódot, hogy megértsük, hogyan és mikor használják őket. Ez segíthet megérteni a szerepe és helye modulok a fő alkalmazás.
6. Figyeljen a stílust.
Te tanulás ezt app nem csak így van, és előbb vagy utóbb, a kód lesz ott is, hogy figyeljen a stílus. Ez magában foglalja olyan dolgok, mint programozási stílus egyezmény: az elnevezés, szóközök, zárójel és konvenciók kódot írni.
Mi a teljes absztrakciós szinten? Ha ez a kód vysokoabstraktny sok absztrakciós szintet, akkor meg kell írni is. Ha ásni a történelem jó, talán akkor képes lesz arra, hogy megtalálják a pillanat, amikor az egyik fejlesztő úgy döntött, hogy elvont néhány kódot. Úgy nézett ki, mint azelőtt, és mi történt vele eltávolítása után egy új absztrakciós szinten? Próbálja meg ugyanezt az egyezmények, ha írsz a kódot.
Ha lemegy a mikroszinten mit tervez használni más fejlesztők a csapat. Ha szívesebben ciklus, hanem a térkép funkció. és akkor talán érdemes választani ciklus. Ha szeretné módosítani a megállapodást, beszélje meg csapatnak a lehetőséget, hogy változtatni őket a jövőben, és nem kezdenek keverni a különböző stílusokat egy fájlban. Jó kód néz ki, mintha minden meg van írva ugyanaz a személy. Következetes sokkal fontosabb, mint hogy okos.
7. Várja találkozik szemetet
8. Ne csüggedjetek
Ne feledje, az előző bekezdésekben, és nem szabad csüggedni, ha úgy érzi teljesen zavaros. tanulási kód - ez nem egy lineáris folyamat, nem számíthat arra, hogy azonnal mindent megérteni 100%. Ügyeljen arra, hogy a fontos részleteket, és tudja, hogyan kell ásni választ találni a kérdésekre, és akkor rájössz, elég gyorsan, hogy minden világossá válik.