Nic nie wp\u0142ywa na prac\u0119 zespo\u0142u w projekcie tak bardzo jak z\u0142y, nieczytelny, niechlujny, pisany na szybko bez przemy\u015blenia kod. Dynamik\u0119 zespo\u0142u da si\u0119 poprawi\u0107, wymagania mo\u017cna przedefiniowa\u0107, a harmonogram mo\u017cna zmodyfikowa\u0107. Jednak z\u0142y kod psuje si\u0119, staj\u0105c si\u0119 coraz wi\u0119kszym ci\u0119\u017carem dla zespo\u0142u.<\/p>\n\n\n\n
Jaki jest czysty kod?<\/strong><\/p>\n\n\n\n Pisz\u0105c ten artyku\u0142, przede wszystkim skupi\u0119 si\u0119 na kilku podstawowych kwestiach dotycz\u0105cych zmiennych oraz funkcji.<\/p>\n\n\n\n Wymy\u015blaj\u0105c nazwy zmiennych stosujmy si\u0119 do kilku zasad, kt\u00f3re sprawi\u0105, \u017ce nasz kod b\u0119dzie bardziej czytelny \u2013 nie tylko dla nas ale i r\u00f3wnie\u017c dla os\u00f3b, kt\u00f3re b\u0119d\u0105 razem z nami tworzy\u0107 kod lub w przysz\u0142o\u015bci przejm\u0105 po nas projekt.<\/p>\n\n\n\n Przede wszystkim nazwy zmiennych nie mog\u0105 by\u0107 jednoliterowe (dwuliterowe r\u00f3wnie\u017c nie \ud83d\ude09 ). Ile razy widzia\u0142e\u015b\/a\u015b zmienn\u0105 x, z, c, a, b, czy jak\u0105kolwiek inn\u0105 liter\u0119 alfabetu i zastanawia\u0142e\u015b\/a\u015b si\u0119 czy dana zmienna jest w og\u00f3le potrzebna? Do czego ona s\u0142u\u017cy? Jaki by\u0142 cel jej stworzenia? Aby odpowiedzie\u0107 sobie na te pytanie musia\u0142e\u015b\/a\u015b przejrze\u0107 kod w poszukiwaniu miejsc, gdzie dana zmienna mog\u0142a zosta\u0107 u\u017cyta. Mniejszy problem, je\u015bli by\u0142a to zmienna w obr\u0119bie jednej funkcji, a co je\u015bli by\u0142a to zmienne globalna? Oczywi\u015bcie wyj\u0105tkiem s\u0105 tutaj zmienne wykorzystywane w p\u0119tlach: i, j, k.<\/p>\n\n\n\n Poszukuj\u0105c wykorzystania danej zmiennej sam\/a zada\u0142e\u015b\/a\u015b sobie pytanie: \u201eJaki by\u0142 cel jej stworzenia?\u201d. Jest to kolejna wa\u017cna kwestia, kt\u00f3r\u0105 powinni\u015bmy uwzgl\u0119dnia\u0107 podczas tworzenia nazw zmiennych. Powinny one przedstawia\u0107 intencj\u0119 osoby tworz\u0105cej kod. Dzi\u0119ki temu nie b\u0119dziesz si\u0119 ju\u017c zastanawia\u0107 czy zmienna odnosi\u0142a si\u0119 do tej funkcjonalno\u015bci, czy mo\u017ce do innej.<\/p>\n\n\n\n Pami\u0119taj r\u00f3wnie\u017c, aby Twoje nazwy nie zawiera\u0142y drobnych r\u00f3\u017cnic. Wi\u0119kszo\u015b\u0107 z nas, jak nie wszyscy, pos\u0142uguj\u0105 si\u0119 wyborem np. metody z klasy, poprzez podpowiedzi naszego IDE. Zastan\u00f3w si\u0119 jak prosto pomyli\u0107 si\u0119 w wyborze odpowiedniej funkcji, kiedy jedyna r\u00f3\u017cnica w ich nazwach to pojedyncza litera na ko\u0144cu? Je\u015bli ju\u017c o tym mowa, to dobr\u0105 praktyk\u0105 jest r\u00f3wnie\u017c tworzenie nazw, kt\u00f3re jeste\u015bmy w stanie wym\u00f3wi\u0107. Nie powoduje to problem\u00f3w z domy\u015blaniem si\u0119 jakie zadanie ma do wykonania dana funkcja.<\/p>\n\n\n\n Par\u0119 przyk\u0142ad\u00f3w:<\/p>\n\n\n\n \u0179le<\/strong><\/p>\n\n\n Dobrze<\/strong><\/p>\n\n\n W r\u00f3\u017cnych projektach cz\u0119sto spotykam si\u0119 z sytuacj\u0105, kiedy kto\u015b nie zastosowa\u0142 sta\u0142ych. Wyobra\u017a sobie sytuacj\u0119, kiedy masz par\u0119 warunk\u00f3w, od kt\u00f3rych zale\u017cy dzia\u0142anie Twojego kodu. W ka\u017cdym z nich sprawdzasz, czy np. ilo\u015b\u0107 produkt\u00f3w w koszyku jest wi\u0119ksza od 6, czy kto\u015b zakupi\u0142 dany produkt itd. Wszystko dzia\u0142a super dop\u00f3ki nie przyjdzie pora, aby zmieni\u0107 warunki promocji. Jak \u0142atwo zapomnie\u0107 o jednym warunku lub po prostu si\u0119 pomyli\u0107. Aby unikn\u0105\u0107 takich sytuacji pos\u0142ugujemy si\u0119 w\u0142a\u015bnie sta\u0142ymi. Dzi\u0119ki ich wykorzystaniu nie tylko mo\u017cemy jednocze\u015bnie zmieni\u0107 warto\u015b\u0107 w wielu miejscach, lecz, co cz\u0119sto wa\u017cniejsze, ich nazwy m\u00f3wi\u0105 nam czego dotyczy dana warto\u015b\u0107.<\/p>\n\n\n\n \u0179le<\/strong><\/p>\n\n\n Dobrze<\/strong><\/p>\n\n\n Popularnym b\u0142\u0119dem w\u015br\u00f3d mniej do\u015bwiadczonych koder\u00f3w, jest r\u00f3wnie\u017c zapisywanie typ\u00f3w zmiennych w ich nazwach. Nie ma co si\u0119 tutaj chyba zbytnio rozpisywa\u0107, bo wydaje mi si\u0119, \u017ce sprawa jest stosunkowo prosta. Nie raz na pewno zdarzy\u0142o Ci si\u0119, \u017ce dana zmienna na pocz\u0105tku Twojej pracy by\u0142a string\u2019iem, jednak po paru zmianach sta\u0142a si\u0119 ona np. int\u2019em.<\/p>\n\n\n\n \u0179le<\/strong><\/p>\n\n\n Starajmy si\u0119 r\u00f3wnie\u017c nie u\u017cywa\u0107 przedrostk\u00f3w. W wielu przypadkach jest on zb\u0119dny i, w oczach bardziej do\u015bwiadczonych programist\u00f3w, po prostu miesza niepotrzebnie w kodzie.<\/p>\n\n\n\n \u0179le<\/strong><\/p>\n\n\n Dobrze<\/strong><\/p>\n\n\n Przejd\u017amy teraz powoli nazw do metod\/funkcji.<\/p>\n\n\n\n Dobra praktyk\u0105, stosowan\u0105 przez wiele os\u00f3b, jest stosowanie czasownik\u00f3w jako nazw metod, np. course.submit() Je\u017celi mamy tak\u0105 mo\u017cliwo\u015b\u0107 starajmy si\u0119 r\u00f3wnie\u017c nie przeci\u0105\u017ca\u0107 konstruktor\u00f3w, a u\u017cywajmy fabryk. Bardzo u\u0142atwia to p\u00f3\u017aniejsze czytanie kodu.<\/p>\n\n\n\n \u0179le<\/strong><\/p>\n\n\n Dobrze<\/strong><\/p>\n\n\n Na ten moment mam dla Ciebie tyle. \u0179le<\/strong><\/p>\n\n\n Dobrze<\/strong><\/p>\n\n\n Mam nadziej\u0119, \u017ce dzi\u0119ki temu artyku\u0142owi Tw\u00f3j kod b\u0119dzie czytelniejszy i bardziej zrozumia\u0142y dla innych. Super, je\u015bli by\u0142 on dla Ciebie tylko od\u015bwie\u017ceniem podstawowych informacji na temat czysto\u015bci kodu. Oboj\u0119tnie, kt\u00f3ra z opcji jest bli\u017csza Twojej wiedzy na ten temat, pami\u0119taj o tym, \u017ce kod, kt\u00f3ry aktualnie piszesz kto\u015b mo\u017ce po Tobie przej\u0105\u0107.<\/p>\n\n\n\n
\nint sc\n \nList<string> list1 = new List<string>();\n \nconst goodWorkersInThisOffice\n \nconst goodWorkerInThisOffice\n \nfunction sendEmails(a,b) {}\n \nClass sdntRcrd\n<\/pre><\/div><\/div>\n\n\n\n\nint studentsCount\n \nList<string> students = new List<string>();\n \nfunction sendEmails(content,recipients) {}\n \nClass StudentRecord\n<\/pre><\/div><\/div>\n<\/div>\n\n\n\n\n\tif (p.count > 9) {}\n<\/pre><\/div><\/div>\n\n\n\n\nconst MIN_PRODUCTS_IN_CART = 9;\nif (products.count > MIN_PRODUCTS_IN_CART) {}\n<\/pre><\/div><\/div>\n<\/div>\n\n\n\n\nint securityCodeString \/\/ zmienna by\u0142a kiedy\u015b stringiem\n<\/pre><\/div>\n\n\n
\nClass Worker {\n \nprivate w_name: string;\n \n setName(name: string) {\n w_name = name;\n }\n}\n<\/pre><\/div><\/div>\n\n\n\n\nClass Worker {\n \nprivate name: string;\n \n setName(name: string) {\n this.name = name;\n }\n}\n<\/pre><\/div><\/div>\n<\/div>\n\n\n\n
U\u017cywanie przedrostk\u00f3w \u201eget\u201d, \u201eset\u201d, \u201eis\u201d r\u00f3wnie\u017c jest polecane oraz u\u0142atwia p\u00f3\u017aniej wykorzystywanie danych funkcjonalno\u015bci.<\/p>\n\n\n\nif (course.isCompleted()) {\n totalCompetedHours += course.getTotalHours();\n user.setTotalHours(totalCompletedHours);\n}\n<\/pre><\/div>\n\n\n\nCity lodz = new City(\"\u0141\u00f3d\u017a\");\n<\/pre><\/div><\/div>\n\n\n\n
\nCity lodz = City.FromName(\"\u0141\u00f3d\u017a\");\n<\/pre><\/div><\/div>\n<\/div>\n\n\n\n
Chcia\u0142bym jednak wspomnie\u0107 jeszcze o paru rzeczach poza tworzeniem nazw:<\/p>\n\n\n\n\n
\nName = \"Imi\u0119 nazwisko\"\n \nclass StudentAddreess\nclass WorkerAddreess\n<\/pre><\/div><\/div>\n\n\n\n
\nWorker.name = \"Imi\u0119 nazwisko\"\n \nclass Address\n<\/pre><\/div><\/div>\n<\/div>\n\n\n\n
\n