Programming Best Practices and Software Design Guidelines

Good programmers focus on writing code that is clear and maintainable for humans, not just for machines. This collection of insights emphasizes the importance of writing readable, efficient, and reusable code. It covers topics such as functions, variable naming, and software design principles for better code organization and understanding.

• Programming
• Best Practices
• Software Design
• Readable Code
• Maintainability

kieron Follow

Uploaded on Jul 26, 2024 | 1 Views

Download Presentation

Please find below an Image/Link to download the presentation.

The content on the website is provided AS IS for your information and personal use only. It may not be sold, licensed, or shared on other websites without obtaining consent from the author. Download presentation by click this link. If you encounter any issues during the download, it is possible that the publisher has removed the file from their server.

Presentation Transcript

1. Any fool can write code that a computer can understand. Good programmers write code that humans can understand. Martin Fowler, "Refactoring: Improving the Design of Existing Code" Programs should be written for people to read, and only incidentally for machines to execute. Abelson & Sussman, Structure and Interpretation of Computer Programs" Always code as if the person who ends up maintaining your code is a violent psychopath who knows where you live. Anon

2. Functions Functions What s the point?

3. Functions Functions Make your code DRY not WET! DRY WET Don t Repeat Yourself We Enjoy Typing def pythag_distance(x1, y1, x2, y2): return sqrt((x2 - x1)**2 + (y2 - y1)**2)

4. Functions Functions Hide complexity ( encapsulation ) Split code sensibly Make code re-usable across projects Generalisation Easier to test

7. Functions Functions Create functions that are: Self-contained (pass/return) Documented Generic/Re-usable No side effects (Or not )

8. Functions Functions how long? how long? 1 line? def pythag_distance(x1, y1, x2, y2): return sqrt((x2 - x1)**2 + (y2 - y1)**2) 1 screen maximum? 1 page maximum? No fixed rules: be sensible

9. Variable naming Variable naming a,b,c,d,e,f,g,h,i,j,k averagevalue maximum_duration_of_the_dropout cnt_uniq_locs number value result temp ROPE

11. Central Heating control Central Heating control New software specification: Runs as a thermostat, keeping the house at a specific temperature Allow manual control of the heating (on/off) Allow delayed control ( turn off in one hour )