Przejdź do głównej zawartości

Werifikacja poprawności kodu

Jak sprawdzić, czy twój kod jest poprawny?


Dziś już oddałem jeden wpis, ale zaoszczędziłem trochę czasu i mogę napisać kolejny. Jest u mnie 22 i może zdążę do północy.
Gdy jesteś początkującym koderem (takim jak ja), chciałbyś wiedzieć, czy twój kod jest poprawny i pisany zgodnie z obowiązującymi standardami. Jednym ze sposobów jest publikacja kodu na forum programistycznym. Kilka razy tak zrobiłem i dostałem treściwą odpowiedź, ale zdarzały się sytuacje, gdy nikt nie odpowiadał. Wtedy zastanawiałem się, czy mój kod jest tak zły, że fachowcy nie mają już siły dopowiadać na te same błędy, czy taki dobry, że nie ma do czego się doczepić. 😉
To niesie także ryzyko, że kod zostanie sprawdzony powierzchownie i o wielu błędach się nie dowiesz. Może się też zdarzyć, że wywiąże się dyskusja pomiędzy kilkoma mistrzami, o tym, jak powinien wyglądać poprawny kod. Po takiej dyskusji zazwyczaj jesteś bardziej skołowany niż przed zadaniem pytania.
Czasami po prostu głupio pytać kolejny raz o sprawdzenie kodu i zawracać ludziom głowę.

Codacy

Parę dni temu trafiłem na Codacy. Na ich stronie można przeczytać: "Check code style, security, duplication, complexity and coverage on every change while tracking code quality throughout your sprints". Hmmm, to coś dla mnie.
Wiecie co, to naprawdę fajnie działa. Co prawda używam dopiero trzeci dzień, ale jest bardzo pomocne.

Na początku Codacy integruje się z twoim GitHubem, ale również może z Bitbucket i GitLab.
Po pomyślnym zalogowaniu i wybraniu repozytorium dostajemy jego analizę.
W lewym górnym rogu widzimy ocenę ogólną naszego kodu. "C" to nawet nieźle, taka nasza 3. Poniżej mamy podział na rodzaje błędów, obok kółko z procentowym podziałem błędów na kategorie. W prawym dolnym rogu wykres występujących problemów po dodawaniu kolejnych commitów. Jak widzicie dzisiejszy commit podniósł mi linie na wykresie.
W zakładce "Commits" możemy się przyjrzeć bliżej naszym commitom. Wydawał mi się, że zrobiłem małe poprawki w kodzie a tu proszę, 39 błędów poprawionych, 57 nowych.
Statystyki, statystykami, ale dopiero to mnie uszczęśliwiło. Program zaznacza niepoprawny fragment kodu, opisuje dlaczego nie powinno się tego tak robić, podaje przykład poprawnego rozwiązania, wyświetla źródło dokumentacji. Nawet informuje o tym ile czasu powinno zająć usuwanie tego błędu. Dla mnie bomba.
Zakładka "files" to rozbicie błędów na pliki, wraz z ich oceną. Średnią ocenę ratują mi pliki CSS. Ciężko mi uwierzyć, że są tak dobrze napisane. W plikach CSS algorytm sprawdzający raczej nie jest efektywny.
W "code patterns" mamy listę narzędzi sprawdzających kod. Możemy je wyłączyć i ustawić własne reguły. Z ciekawości sprawdziłem mój kod w CSSLint online i wysypało dużo błędów. Widocznie narzędzie CSSLint w Codacy, nie działa jak powinno. 

Po commicie przychodzi mail informujący o jego jakości.

Pomimo tego małego zgrzytu z CSS, Codacy to bardzo przydatne narzędzie dla początkujących programistów. Poprawa kodu sprawia frajdę. Ocena rośnie, słupki błędów idą w dół.

Codacyma wersję darmową i płatną 15$ na miesiąc. W płatnej masz nieograniczone prywatne repozytoria, szybsza analza i inne dodatki. W wersji darmowej nieograniczone repozytoria ma kod open source.

Komentarze

Popularne posty z tego bloga

Program do organizacji pracy

Nawiązując do poprzedniego postu, w którym przedstawiłem plan działania, chciałbym wam pokazać program do zarządzania listą zadań. Do tej pory chwilę używałem strony Trello . Trello posiada wszystko, co powinien mieć program "to do list". Jeżeli do tej pory nie używałeś żadnego, to wymienię czym powinieneś się kierować przy wyborze dobrego menadżera zadań. Nie będę tutaj wymieniał oczywistości, takich jak dodawanie zadań z datą. Menadżer zadań powinien posiadać:  dostęp z przeglądarki, aplikację na urządzenia przenośne, możliwość pracy w grupie, system powiadomień o nadchodzących "deadlines" oraz zmianach na liście,  opcje kopiowania list, zadań - przydatne, kiedy co tydzień powtarzasz te same zadania, możliwość dodawania komentarzy ludzi biorących udział w zadaniach, dodawanie załączników, zdjęć i innych plików multimedialnych, tworzenie podzadań, chcecklist  lub listy zakupów (funkcjonalność podobna), oznaczanie ważnych zadań, Dobrze, gdyby posia...

Pora się pożegnać

Postanowienie z poprzedniego posta Tak, to już ostatni dzień konkursu. Za nim zrobię podsumowanie całego projektu, wrócę do mojego poprzedniego wpisu . Narzekałem w nim, że wykryłem błąd. Myślałem, że szybko go naprawię i poprawię mój kod. Ten easy-peasy bug, zajął 3 dni! Przebudowywałem kod 3 razy. W końcu zwróciłem się z problemem na forum i dostałem podpowiedź, która pomogła mi rozwiązać problem. W tych dwóch krótkich  metodach miałem dwa bugi, które aktywowały się na przemian,  przez co zachowanie metod wyglądało na losowe. Prawione metody w obiekcie Controller: https://github.com/commit Przez ten błąd, nie starczyło mi czasu na poprawę jakości kodu. Jednak jeszcze się nie poddaję. Jak znajdę dziś trochę czasu, to poprawię go i wyślę na githuba. Podsumowanie W czasie tego konkursu wypiłem 167 kaw, zużyłem ..., ale to Was pewnie nie interesuje. Jeden z głównych warunków konkursu został spełniony. Ponad 20 postów zostało upublicznione. W utrzymaniu samodyscyplin...

Affinity Designer

Pierwsze wrażenia Postanowiłem przetestować młody program Affinity Designer do stworzenia grafiki wektorowej. W porównaniu do jego wielkich rywali CorelDRAW oraz Adobe Illustrator jest znacznie tańszy. Od CorelDRAW ponad 10 razy, a porównując z ceną Illustratora, to koszt 2 miesięcy abonamentu. Ja jednak jeszcze nie kupiłem go i wykorzystuję darmowy okres próbny 10 dni. Nie będę porównywał możliwości pomiędzy wymienionymi programami, ponieważ ich nie używam, ale korzystam z innego, darmowego Inkscape. Na pierwszy rzut oka, Affinity ma nowocześniejszy i schludny wygląd. Gdy korzystałeś z podobnych programów do tworzenia grafiki wektorowej, przesiadka i zaaklimatyzowanie zajmie Ci tylko chwilę. Jednak są pewne niuanse. Mnie chwilę zajęło szukanie ikonki do usunięcia zbędnego węzła. Po chwili szukania w googlach okazało się, że ikony nie ma, a węzły usuwa się klawiszem delete. Inkscape zawiera więcej opcji. W Affinity nie można ścieżkom ustawić nazw klas css. To dla mnie...