Czysty kod - wstęp

By -

Witam cię czytelniku.

Skoro tutaj zajrzałeś to znaczy, że chcesz stać się lepszym programistą. Postanowiłem stworzyć serię wpisów, która będzie mówiła o przejrzystym i czystym kodzie. Chciałbym, abyś zostawił komentarz pod wpisem, jeżeli masz jakieś wątpliwości lub spostrzeżenia. Jednocześnie odpowiem chętnie na wszystkie pytania związane z tym tematem. Nie mówię, że wypracowany przeze mnie system jest najlepszy dlatego prosiłbym także o Waszą opinie, która pozwoli stworzyć nam porady jak pisać czysty i czytelny kod. A więc zaczynajmy.

Co to znaczy czysty kod?

Jest to kod napisany tak, że dla użytkownika tego kodu (drugiego programisty, a nawet autora) będzie on czytelny nawet po długim czasie. To kod, który pozwala na łatwe i przyjemne przeglądanie, gdzie widać co się w nim dzieje. Kod powinień być prosty, pomimo skomplikowanych algorytmów. Osoba nie znająca systemu powinna w łatwy sposób wywnioskować co fragment kodu robi.

Co potrzeba, aby pisać czysty kod?

Bardzo dużej dyscypliny, doświadczenia i czasu. Kod powinień być ciągle poprawiany. Nie ma programu napisanego idealnie. Zawsze można coś poprawić. Nazewnictwo zmiennej lub metody, optymalizacja algorytmu, usunięcie zbędnego komentarza itd. Problem jest w tym, że nie zawsze zauważamy, że coś można byłoby poprawić.

Podsumowując

Skoro wiemy już jak zdefiniować czysty kod oraz co potrzebujemy do jego uzyskania, zaczynamy serię ciężkiej pracy do uzyskania oczekiwanego efektu. Seria będzie opisana na podstawie języka Java, ale zastosować ją można do wszystkich języków programowania. Zacznijmy, więc od komentarzy.

Comments

Post a Comment

Popular posts from this blog

Why TDD is bad practice?

By -
Image
Did you listen that TDD is bad? What do you think about it? I have my opinion about it! TDD is bad because... We don't have time to write tests first - I think this is a good point. I sometimes don't have time for that. Why? Because I need to do quickly fix on our code and deploy it. In this case I don't have time to create test after wrote production code too. The even worse case is when we have tested this part of our code and test after change doesn't work. I don't like this, because I must read tests and thinking about repair tests for new logic. I really don't like this. I would like to create new test and remove old every time when I have that situation. What's wrong with the test first on this case? Nothing, because if you have time to write tests after create code, you have time to create test before it. Don't you think so? We know how will implement it, but we don't know how testing it - I think a lot of developers have this problem,
Read more >>

How correctly imitate dependencies?

By -
Image
This is continuous of my previous post about why we should imitate our dependencies. I did it not long ago. I though about how do it properly and when I can say that it is correct. Start from test and real dependencies I am starting from the tests. I wrote the simple tests which, I though, are correct. That was my learned about dependencies. I had the good situation that I had some prepared tests before. During the writing test I got a knowledge. A lot of time, I verified what the system return. After it, I got the full automated tests for my dependency. Now, I am sure that dependency works like I think. Like my test use it. I think this is a very good advantage. Extract the interface for communicating The implementation to communicate is implemented and tested. Our test, if you implement it like functionality test, not code test, should show us, how we want to use our dependency. We know what parameters we use, what methods. We know what we want. That is a place where we must extr
Read more >>

Software development using Angular 5 with Spring Boot

By -
Image
Hi everyone. My last the bigger post is about configuration Spring Boot and Angular 5 . After that instruction we have integrated both technology on one app. If you created it you know that development is very hard in this case. We must waiting for build a client and it isn't effective. We can use webpack-dev-server to speed up this process, so this post is just about it. Angular and webpack-dev-server I think I have to explain webpack and webpack-dev-server. The first tools let pack our angular app to one or more files. This files is bundles. It is for improve speed of our app. Why? Because one page application need all files on start by assumption. The better way is load it using only one connection and one file, because establishing connection taking time. This is a few information about webpack, but what is webpack-dev-server? This is the tool. It serve our that files which webpack compiled, but it working on memory, so we have quick result on our browser. This is a amazing
Read more >>