Clean up your mess!
•Download as PPTX, PDF•
5 likes•1,420 views
The document discusses best practices for organizing code and writing documentation. It recommends organizing code into modules for each feature and directories for each type of object. Patterns are useful for abstraction and communication between developers. Commit messages should follow certain rules like limiting the subject line to 50 characters and using present tense. Documentation for APIs can be generated using tools like ScalaDoc, javadoc, JSDoc and others. Overall the document stresses the importance of keeping code clean, consistent and well-documented.
More Related Content
Similar to Clean up your mess!
Similar to Clean up your mess! (20)
Recently uploaded
Recently uploaded (20)
Clean up your mess!
- 1. Clean Up Your Mess! By: Omnia Gamal twitter: @Omnia_G webSite: omnia.ninja
- 3. Piles on the Floor Please, give me the white T-shirt ? WHAT???
- 4. The file pattern: a file for each type of object
- 5. The Sock Drawer Please, give me the blue T-shirt, the blue jeans and blue shoes.
- 6. The folders pattern: a directory for each type of object
- 7. Modularity The module pattern: a module for each feature Now any random developer can open the top-level folder and immediately gain insight into what the application does.
- 9. what that mean? ● Is readable ● Is consistent ● Is predictable ● Looks as if it was written by the same person ● Is documented
- 11. Patterns
- 12. Why? ● Not reinvent the wheel. ● Abstraction ● Communication between developers
- 13. Writing Clear GIT Commit Message
- 16. Told me, Which would you rather read?
- 17. A diff will tell you what changed, but only the commit message can properly tell you why.
- 18. The rules of a great git commit message 1. Separate subject from body with a blank line 2. Limit the subject line to 50 characters 3. Capitalize the subject line 4. Do not end the subject line with a period 5. Use present tense. 6. Don’t use “I”, “Me”, ... 7. Use the body to explain what and why vs. how
- 19. Writing API DOC
- 20. ScalaDoc javadoc JSDoc doxx Docco
- 21. KEEP CLAM AND CLEAN UP Your MESS
- 22. Any Question?
- 23. ref: ● Scalable code organization in AngularJS ● Code Organization in Large AngularJS and JavaScript Applications ● How to Write a Git Commit Message ● Essentials - Chapter 2 / O’REILLY - JavaScript Patterns by Stoyan Stefanov
Editor's Notes
- Software bugs are costly to fix. And their cost increases over time, especially if the bugs creep into the publicly released product. It’s best if you can fix a bug right away, as soon you find it; this is when the problem your code solves is still fresh in your head. Otherwise you move on to other tasks and forget all about that particular code. Revis- iting the code after some time has passed requires: • Time to relearn and understand the problem • Time to understand the code that is supposed to solve the problem Another problem, specific to bigger projects or companies, is that the person who eventually fixes the bug is not the same person who created the bug (and also not the same person who found the bug). It’s therefore critical to reduce the time it takes to understand code, either written by yourself some time ago or written by another de- veloper in the team. It’s critical to both the bottom line (business revenue) and the developer’s happiness, because we would all rather develop something new and excit- ing instead of spending hours and days maintaining old legacy code. Another fact of life related to software development in general is that usually more time is spent reading code than writing it. In times when you’re focused and deep into a problem, you can sit down and in one afternoon create a considerable amount of code.
- multiple thread A third-party library Scripts from an advertising partner Code from a third-party user tracking and analytics script Different kinds of widgets, badges, and buttons
- They provide a level of abstraction—the brain can hold only so much at a given time, so when you think about a more complex problem, it helps if you don’t bother with the low-level details but account for them with self-contained building blocks (patterns). • They improve communication between developers and teams, which are often in remote locations and don’t communicate face to face. Simply putting a label on some coding technique or approach makes it easier to make sure we’re talking about the same thing. For example, it’s easier to say (and think) “immediate func- tion,” than “this thing where you wrap the function in parentheses and at the end of it put another set of parentheses to invoke the function right where you’ve de- fined it.”