Always try to use micro-service architecture. And also it will be good start for global code documentation. This will save much time for understanding and even more - it will give people more chances to come up with better implementation of this method. But what to do to save time for new developers? - Write simple inline documentation describing what and how method work. Good code should be understandable without a line of comments. Code should do only what it need without tons of abstraction and other OOP shit (especially it concerns java developers) + 20% of things that may be needed in future to update it in simple way. More it simpler then less bugs it may have and less time needed to debug them. Remember that code with badly written tests can be more harmful then code without tests. When you write scripts that can be simply tested manually by their output. When you have small team and code changing is fast. When you don’t need test: - When you are a startup. When you have resources for updating tests at the same time as code was updated. When you are writing code that touches financial channels. When you need tests: - When you are writing modules, micro-services which will be not touched for at least one month. Tests are good thing but they are not always affordable and make sense for the project. Before writing the first line of the code, you should understand what it will be doing, how, what it will use, how modules, services will work with each other, what structure will it have, how it will be tested and debugged, and how it will be updated. Writing code without thinking of its architecture is useless in the same way as dreaming about your desires without a plan of achieving them. And about 99% of them got big problems because of such thinking. I saw many people who was saying “We need doing things fast we have no time on making architecture”. If you need to make optimization, then make it like independent module with DI, with 100% test coverage and which will not be touched for at least one year. Because time and resources that will be spent on hard readable code will be much higher than what you get from optimization. Always write code that simple to read and which will be understandable for developers. And i want to share with you my rules of writing good code. Hi guys, i work as a programmer more than 15 years and was using many different languages, paradigms, frameworks and other shit.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. Archives
December 2022
Categories |