While this is valid JavaScript, the block can't // be properly folded due to its mixed indentation. So every time I open a file, I would have to fix the indentation before I can even start working. When the indentation isn’t coherent, this features fails. ![]() Without that feature, I am literally lost in a file. For instance, I am a huge fan of code folding. Why is this even important? Everyone has it’s own way of using an editor or IDE. Your names should clearly communicate what your code does, why it does it, and how it does it. ![]() Opinions are fine, but a good project makes sure all developer can work without hassle. Naming is one of the most important aspects of writing readable and maintainable code. Only when the codebase has mixed indentation is it necessary to decide which to use. Is the codebase written in spaces? Continue with spaces. The famous question (it’s rather a war though), whether spaces or tabs should be used, doesn’t matter. editorconfig file to keep coding style guides consistent between different editors, IDE’s, and developers. Now that you have all information about the projects toolchain, you know the structure and how the logic is connected, it’s time to create a baseline. This is all about establishing consistency. ![]() If they are no unit tests in your project, don’t worry, we will come to that. Reading - and running - unit tests gives you a much deeper understanding than reading only code. Unit testing is a way of testing functionality and the methods of your code to ensure your code behaves as intended. Knowing the technologies is a good start, but to get a real feel and understanding, it’s time to look into the unit tests. Let’s say the project is written in Angular 2 and you haven’t worked with that, go straight to the documentation and get a basic understanding. jQuery? React? Express? Make a list of everything that is important to know. main.js, index.js, app.js, …) where either all modules are initialized or, in the worst case, the entire business logic is located.įind out which tools are in use. In the best case the project has an entry point (e.g. If it’s a Node.js project, open the command line interface and go through the API. ![]() While doing that, have the Developer Tools open, to see if any errors are popping up or anything is getting logged. If it’s a website, click your way through all the functionality: open modals, send forms and so on. The very first step is to get an overview of what is going on.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |