CLEAN CODE
•Download as ODP, PDF•
2 likes•156 views
Clean code is subjective and every developer has a personal take on it. There are some ideas that are considered best practice and what constitutes clean code within the industry and community, but there is no definitive distinction.
Report
Share
Report
Share
Recommended
Clean code, Feb 2012
This document discusses the principles of clean code based on Robert C. Martin's book "Clean Code". It covers topics like why clean code is important, guidelines for writing clean code like keeping methods small and using descriptive names, design principles like DRY and YAGNI, and code smells to avoid like long methods and duplicated code. The overall goal is to create code that is easy to read, understand and maintain over time.
Clean Code
Presentation on writing clean and maintainable good. I have present really simple steps to write high quality code and share many more benefit of writing clean code.
Clean code
This ppt is based on the book "Clean Code" written by Robert C Martin. It's a wonderful book and cover all the mistakes that we do while writing bad code. I am sharing few good practices shared in the book, hope you will like it
Clean code coding like a professional
Chia sẻ về Clean Code tại XPDay Vietnam 2016.
Clean Code là gì?
Tại sao phải Clean Code?
Clean Code có khó không?
Một số ví dụ thực tế về áp dụng Clean Code.
YAGNI Principle and Clean Code
YAGNI = You Ain’t Gonna Need It
Emerged as one of the key principles of Extreme Programming
and says that you should do the simplest thing that could Possibly work!
Clean code
Which size should the function be of? What is one thing? Which comments are bad?
Robert Martin's view on agile software craftsmanship. Smells and heuristics of code.
Lambdas
This document discusses Java 8 features including defining methods in interfaces, functional programming concepts, lambda expressions, and the stream API. Key points include: interfaces can now define default and static methods; functional programming uses declarative code, avoids mutability, and handles concurrency; lambda expressions define anonymous methods; and the stream API processes data in parallel streams to leverage multi-core architectures.
Clean Code and Common Engineering Practices
Clean code essentials and engineering practices in a nutshell. If following this short presentation you'll read more about it, I've done my part
Recommended
Clean code, Feb 2012
This document discusses the principles of clean code based on Robert C. Martin's book "Clean Code". It covers topics like why clean code is important, guidelines for writing clean code like keeping methods small and using descriptive names, design principles like DRY and YAGNI, and code smells to avoid like long methods and duplicated code. The overall goal is to create code that is easy to read, understand and maintain over time.
Clean Code
Presentation on writing clean and maintainable good. I have present really simple steps to write high quality code and share many more benefit of writing clean code.
Clean code
This ppt is based on the book "Clean Code" written by Robert C Martin. It's a wonderful book and cover all the mistakes that we do while writing bad code. I am sharing few good practices shared in the book, hope you will like it
Clean code coding like a professional
Chia sẻ về Clean Code tại XPDay Vietnam 2016.
Clean Code là gì?
Tại sao phải Clean Code?
Clean Code có khó không?
Một số ví dụ thực tế về áp dụng Clean Code.
YAGNI Principle and Clean Code
YAGNI = You Ain’t Gonna Need It
Emerged as one of the key principles of Extreme Programming
and says that you should do the simplest thing that could Possibly work!
Clean code
Which size should the function be of? What is one thing? Which comments are bad?
Robert Martin's view on agile software craftsmanship. Smells and heuristics of code.
Lambdas
This document discusses Java 8 features including defining methods in interfaces, functional programming concepts, lambda expressions, and the stream API. Key points include: interfaces can now define default and static methods; functional programming uses declarative code, avoids mutability, and handles concurrency; lambda expressions define anonymous methods; and the stream API processes data in parallel streams to leverage multi-core architectures.
Clean Code and Common Engineering Practices
Clean code essentials and engineering practices in a nutshell. If following this short presentation you'll read more about it, I've done my part
Test Driven Development
This document discusses test-driven development (TDD) and its benefits. It advocates following a process of writing tests before code to ensure code quality and prevent bugs. TDD involves writing a test, seeing it fail, writing the minimum code to pass the test, and refactoring code as needed. While initially time-consuming, TDD can save time in the long run by producing well-designed, modular code that is documented by tests and catches errors early. The document provides examples of TDD and cautions that intelligence alone is not enough - following a disciplined process is important for success.
Clean code and Coding Standards
The document discusses clean coding standards and best practices. It recommends following the Boy Scout Rule of leaving the code cleaner than you found it. It discusses using meaningful names for classes, methods, and variables without encodings. Functions should do one thing, use descriptive names, and avoid repeating code. Comments should explain intent, not make up for bad code. Error handling prefers exceptions over return codes. Formatting and style rules should be consistent within a team. Coding standards exist for many languages like Java, PHP, C#, Android and others.
Clean code - Getting your R&D on board
How do you go about implementing clean code in a medium R&D organization? As tech lead of scrum team, I describe the process implemented in AT&T Israel as case study
Training methdology testers to developers
This document outlines a methodology for transitioning testers to developers by starting them with bug fixing, unit testing with JUnit, problem solving, and then gradually introducing more advanced programming concepts like OOP and core Java. The approach begins by giving testers simple programs with bugs to find and fix. It then teaches unit testing and has them write test code. Problem solving skills are developed by having them solve scenarios on paper and learning to code solutions. The training progresses to more complex problems and programming topics until testers fully transition to thinking and working like programmers. A trainer with both technical and soft skills is needed to change testers' mindsets and ensure a 100% success rate.
Make a better with clean code
This slide created for shared internal and for everyone interesting clean code. Why we needed? Why you should use it?
Ps. Sorry if my grammar is very bad :D
Paradigm Wars: Object Oriented Vs Functional Programming in creating MarkParser
In this project my team and I tried our hands-on Functional Programming. Our aim was to compare challenges, efforts, and ease in developing a same application "MarkParser" (a Markdown parser) using both the paradigms.
Best Practices of Software Development
Folio3 is a software development company that focuses on designing custom enterprise, mobile, and social media applications. They have over 200 employees across offices in the US, Canada, Bulgaria, and Pakistan. The document outlines Folio3's areas of expertise and best practices for software development and databases, including using consistent naming conventions, short methods, clear comments, specific exceptions, and avoiding wildcard queries.
Caring About Code Quality (Clean Code, GRASP, Effective Java, Design Pattern)
Code quality is not an exact science and is rather subjective, which brings the need of well defined rules and principles to follow.
Clean code is all about readability, furthermore, principles like GRASP or techniques like fluent APIs makes the code even cleaner and maintainable.
Design Patterns on the other hand are typical solutions to common problems in software design.
You will walk away with a taste of quality principles and metrics for building quality software.
Also previews of some useful books like Martin Fowler's Clean Code and Kent Beck's Implementation Patterns are presented.
Common design patterns in php
This document discusses common PHP design patterns. It begins by defining design patterns and mentioning the "Gang of Four" design patterns book. It then proceeds to describe several design patterns in detail, including Factory, Singleton, Strategy, Command, Chain of Responsibility, Observer, MVC, Front Controller, Adapter, and Facade patterns. Other patterns are also briefly listed.
Test Driven Development
The document discusses test-driven development (TDD) and design-driven development (DDD). It advocates for writing tests before code using short iterative development cycles. TDD helps produce clean code that fulfills requirements by making developers think about required behavior, providing documentation, and improving quality. Common objections to TDD are addressed, noting that it forces understanding of code and tests, creates reusable modular code, and drives simplicity. Guidelines for effective TDD include writing small focused tests with descriptive intentions that are independent and repeatable.
[CocoaHeads Tricity] Maciej Burda - Working as an iOS developer Interview Cas...
The document provides tips and guidance for an iOS developer seeking a new job. It discusses signs that it may be time to change jobs, how often programmers typically change jobs (1.5-2 years in the US), where to look for jobs (websites and networking), how to prepare by understanding the recruitment process and defining your level of experience. It also offers suggestions for how to showcase your skills as a strong iOS developer, including through clean, well-designed code; use of Git; strong UI/UX skills; theoretical knowledge; collaboration skills; and demonstrating language features and design patterns. The document closes by suggesting technical questions you may be asked during an interview.
Everyday Functional Programming in JavaScript
This document summarizes a presentation on everyday functional programming in JavaScript. The presentation introduces functional programming concepts like using functions as atomic units with known input-output behavior, immutable data to help with simplicity and parallel processing, and declarative code to make intentions clear. It also discusses how many developers may already be using functional programming techniques without realizing it when using React and its function components to render views.
Code Review
Presentation from Agile Base Camp 2 conference (Kiev, May 2010) and AgileDays'11 (Moscow, March 2011) about one of the most useful engineering practices from XP world.
Advanced unit testing – real life examples and mistakes
This document discusses unit testing best practices and common mistakes. It provides examples from testing a core application called SCA. Key topics covered include goals of unit testing like improved quality, dangers like additional costs, test organization patterns like using a database sandbox or fake database, lessons learned like avoiding fragile tests, tips for Visual Studio and TFS, and common code smells to avoid like long test setup logic. The overall message is that unit tests provide benefits but also risks, and best practices and avoiding code smells can help maximize the upsides and minimize the downsides of unit testing.
Scala the good and bad parts
This document discusses the good and bad parts of Scala programming. It covers several programming paradigms like object-oriented programming, functional programming, and logic programming. It provides examples of code in Java and Scala for concepts like classes, filtering lists, pattern matching, and quicksort. The document notes some complaints about Scala like long compile times, confusing library syntax and documentation, and issues with type inference. It recommends learning Scala through the Coursera course on functional programming principles.
Real Life Unit Testing
Tools are not enough. If you want to succeed overtime, you need more ammunition. Some people call them best practices. We call them real life lessons.Why should every developer unit test his code, Unit testing tools,TDD & Unit testing best practices, How to avoid writing fragile tests and Testing special scenarios
Being Good Developer
The document discusses tips for being a good developer, including writing good code through principles like the single responsibility principle, DRY principle, and design patterns. It emphasizes writing clean, readable code through practices like object-oriented programming, refactoring, and code documentation. Being a good developer also means having soft skills like admitting limitations, learning from others, teamwork, communication, and embracing failure while taking risks and learning new technologies.
Clean Code
The document discusses principles for writing clean code, including:
- Functions should do one thing and be small, with descriptive names.
- Code should be organized in a way that reads like well-written prose from top-level functions down.
- Comments are usually a code smell and cleaning up code is preferable to adding comments.
- Overall the goal is for code to be easy to read and understand at a glance.
Your first 5 PHP design patterns - ThatConference 2012
This document discusses 5 common PHP design patterns: Singleton, Factory, Observer, Decorator, and Strategy. For each pattern, it provides a brief definition, examples of when it may be used, and code samples demonstrating its implementation in PHP. The document aims to introduce PHP developers to fundamental design patterns in an accessible way and encourage applying these patterns to improve code organization and reusability. It also stresses that design patterns are language-agnostic solutions to recurring problems and have been used by developers for many years, even if unfamiliar to some PHP programmers.
OOP in Java
This document provides an introduction to object-oriented programming concepts and Java. It discusses software engineering principles like abstraction, encapsulation, inheritance and polymorphism. It then gives a brief overview of Java, including its history and platforms. The document encourages readers to learn programming through reading, exercises, courses, projects and discussions to become better programmers.
Clean code and code smells
The document discusses principles of clean code and code smells. It provides definitions and examples of clean code from various experts, including short functions that do one thing, meaningful names, comments that are useful but not redundant, and following the law of Demeter. The document also discusses writing classes with good organization and a single responsibility.
Software Craftmanship - Cours Polytech
The document discusses principles of craftsmanship in software development, including clean code, test-driven development, domain-driven design, and refactoring. It emphasizes writing code with quality, simplicity, shared ownership, and professionalism. It provides examples of unit testing principles like FAST and describes techniques like the TDD loop and code katas/dojos. It also explains SOLID principles for object-oriented design such as single responsibility, open/closed, Liskov substitution, and others. Finally, it discusses refactoring code smells and techniques for improving code quality through refactoring.
More Related Content
What's hot
Test Driven Development
This document discusses test-driven development (TDD) and its benefits. It advocates following a process of writing tests before code to ensure code quality and prevent bugs. TDD involves writing a test, seeing it fail, writing the minimum code to pass the test, and refactoring code as needed. While initially time-consuming, TDD can save time in the long run by producing well-designed, modular code that is documented by tests and catches errors early. The document provides examples of TDD and cautions that intelligence alone is not enough - following a disciplined process is important for success.
Clean code and Coding Standards
The document discusses clean coding standards and best practices. It recommends following the Boy Scout Rule of leaving the code cleaner than you found it. It discusses using meaningful names for classes, methods, and variables without encodings. Functions should do one thing, use descriptive names, and avoid repeating code. Comments should explain intent, not make up for bad code. Error handling prefers exceptions over return codes. Formatting and style rules should be consistent within a team. Coding standards exist for many languages like Java, PHP, C#, Android and others.
Clean code - Getting your R&D on board
How do you go about implementing clean code in a medium R&D organization? As tech lead of scrum team, I describe the process implemented in AT&T Israel as case study
Training methdology testers to developers
This document outlines a methodology for transitioning testers to developers by starting them with bug fixing, unit testing with JUnit, problem solving, and then gradually introducing more advanced programming concepts like OOP and core Java. The approach begins by giving testers simple programs with bugs to find and fix. It then teaches unit testing and has them write test code. Problem solving skills are developed by having them solve scenarios on paper and learning to code solutions. The training progresses to more complex problems and programming topics until testers fully transition to thinking and working like programmers. A trainer with both technical and soft skills is needed to change testers' mindsets and ensure a 100% success rate.
Make a better with clean code
This slide created for shared internal and for everyone interesting clean code. Why we needed? Why you should use it?
Ps. Sorry if my grammar is very bad :D
Paradigm Wars: Object Oriented Vs Functional Programming in creating MarkParser
In this project my team and I tried our hands-on Functional Programming. Our aim was to compare challenges, efforts, and ease in developing a same application "MarkParser" (a Markdown parser) using both the paradigms.
Best Practices of Software Development
Folio3 is a software development company that focuses on designing custom enterprise, mobile, and social media applications. They have over 200 employees across offices in the US, Canada, Bulgaria, and Pakistan. The document outlines Folio3's areas of expertise and best practices for software development and databases, including using consistent naming conventions, short methods, clear comments, specific exceptions, and avoiding wildcard queries.
Caring About Code Quality (Clean Code, GRASP, Effective Java, Design Pattern)
Code quality is not an exact science and is rather subjective, which brings the need of well defined rules and principles to follow.
Clean code is all about readability, furthermore, principles like GRASP or techniques like fluent APIs makes the code even cleaner and maintainable.
Design Patterns on the other hand are typical solutions to common problems in software design.
You will walk away with a taste of quality principles and metrics for building quality software.
Also previews of some useful books like Martin Fowler's Clean Code and Kent Beck's Implementation Patterns are presented.
Common design patterns in php
This document discusses common PHP design patterns. It begins by defining design patterns and mentioning the "Gang of Four" design patterns book. It then proceeds to describe several design patterns in detail, including Factory, Singleton, Strategy, Command, Chain of Responsibility, Observer, MVC, Front Controller, Adapter, and Facade patterns. Other patterns are also briefly listed.
Test Driven Development
The document discusses test-driven development (TDD) and design-driven development (DDD). It advocates for writing tests before code using short iterative development cycles. TDD helps produce clean code that fulfills requirements by making developers think about required behavior, providing documentation, and improving quality. Common objections to TDD are addressed, noting that it forces understanding of code and tests, creates reusable modular code, and drives simplicity. Guidelines for effective TDD include writing small focused tests with descriptive intentions that are independent and repeatable.
[CocoaHeads Tricity] Maciej Burda - Working as an iOS developer Interview Cas...
The document provides tips and guidance for an iOS developer seeking a new job. It discusses signs that it may be time to change jobs, how often programmers typically change jobs (1.5-2 years in the US), where to look for jobs (websites and networking), how to prepare by understanding the recruitment process and defining your level of experience. It also offers suggestions for how to showcase your skills as a strong iOS developer, including through clean, well-designed code; use of Git; strong UI/UX skills; theoretical knowledge; collaboration skills; and demonstrating language features and design patterns. The document closes by suggesting technical questions you may be asked during an interview.
Everyday Functional Programming in JavaScript
This document summarizes a presentation on everyday functional programming in JavaScript. The presentation introduces functional programming concepts like using functions as atomic units with known input-output behavior, immutable data to help with simplicity and parallel processing, and declarative code to make intentions clear. It also discusses how many developers may already be using functional programming techniques without realizing it when using React and its function components to render views.
Code Review
Presentation from Agile Base Camp 2 conference (Kiev, May 2010) and AgileDays'11 (Moscow, March 2011) about one of the most useful engineering practices from XP world.
Advanced unit testing – real life examples and mistakes
This document discusses unit testing best practices and common mistakes. It provides examples from testing a core application called SCA. Key topics covered include goals of unit testing like improved quality, dangers like additional costs, test organization patterns like using a database sandbox or fake database, lessons learned like avoiding fragile tests, tips for Visual Studio and TFS, and common code smells to avoid like long test setup logic. The overall message is that unit tests provide benefits but also risks, and best practices and avoiding code smells can help maximize the upsides and minimize the downsides of unit testing.
Scala the good and bad parts
This document discusses the good and bad parts of Scala programming. It covers several programming paradigms like object-oriented programming, functional programming, and logic programming. It provides examples of code in Java and Scala for concepts like classes, filtering lists, pattern matching, and quicksort. The document notes some complaints about Scala like long compile times, confusing library syntax and documentation, and issues with type inference. It recommends learning Scala through the Coursera course on functional programming principles.
Real Life Unit Testing
Tools are not enough. If you want to succeed overtime, you need more ammunition. Some people call them best practices. We call them real life lessons.Why should every developer unit test his code, Unit testing tools,TDD & Unit testing best practices, How to avoid writing fragile tests and Testing special scenarios
Being Good Developer
The document discusses tips for being a good developer, including writing good code through principles like the single responsibility principle, DRY principle, and design patterns. It emphasizes writing clean, readable code through practices like object-oriented programming, refactoring, and code documentation. Being a good developer also means having soft skills like admitting limitations, learning from others, teamwork, communication, and embracing failure while taking risks and learning new technologies.
Clean Code
The document discusses principles for writing clean code, including:
- Functions should do one thing and be small, with descriptive names.
- Code should be organized in a way that reads like well-written prose from top-level functions down.
- Comments are usually a code smell and cleaning up code is preferable to adding comments.
- Overall the goal is for code to be easy to read and understand at a glance.
Your first 5 PHP design patterns - ThatConference 2012
This document discusses 5 common PHP design patterns: Singleton, Factory, Observer, Decorator, and Strategy. For each pattern, it provides a brief definition, examples of when it may be used, and code samples demonstrating its implementation in PHP. The document aims to introduce PHP developers to fundamental design patterns in an accessible way and encourage applying these patterns to improve code organization and reusability. It also stresses that design patterns are language-agnostic solutions to recurring problems and have been used by developers for many years, even if unfamiliar to some PHP programmers.
OOP in Java
This document provides an introduction to object-oriented programming concepts and Java. It discusses software engineering principles like abstraction, encapsulation, inheritance and polymorphism. It then gives a brief overview of Java, including its history and platforms. The document encourages readers to learn programming through reading, exercises, courses, projects and discussions to become better programmers.
What's hot (20)
Paradigm Wars: Object Oriented Vs Functional Programming in creating MarkParser
Paradigm Wars: Object Oriented Vs Functional Programming in creating MarkParser
Caring About Code Quality (Clean Code, GRASP, Effective Java, Design Pattern)
Caring About Code Quality (Clean Code, GRASP, Effective Java, Design Pattern)
[CocoaHeads Tricity] Maciej Burda - Working as an iOS developer Interview Cas...
[CocoaHeads Tricity] Maciej Burda - Working as an iOS developer Interview Cas...
Advanced unit testing – real life examples and mistakes
Advanced unit testing – real life examples and mistakes
Your first 5 PHP design patterns - ThatConference 2012
Your first 5 PHP design patterns - ThatConference 2012
Similar to CLEAN CODE
Clean code and code smells
The document discusses principles of clean code and code smells. It provides definitions and examples of clean code from various experts, including short functions that do one thing, meaningful names, comments that are useful but not redundant, and following the law of Demeter. The document also discusses writing classes with good organization and a single responsibility.
Software Craftmanship - Cours Polytech
The document discusses principles of craftsmanship in software development, including clean code, test-driven development, domain-driven design, and refactoring. It emphasizes writing code with quality, simplicity, shared ownership, and professionalism. It provides examples of unit testing principles like FAST and describes techniques like the TDD loop and code katas/dojos. It also explains SOLID principles for object-oriented design such as single responsibility, open/closed, Liskov substitution, and others. Finally, it discusses refactoring code smells and techniques for improving code quality through refactoring.
Developing Better Software
Since guideline developing better software, in 3 main areas: software security, performance, and self development.
Clean code
This document summarizes key principles for writing clean code as outlined in the book "Clean Code" by Robert C. Martin. It discusses ideas like writing code that is easy to read and understand through use of meaningful names, small functions that do one thing well, and avoiding duplication. It also covers principles for object-oriented design like encapsulation, organization for change, and separation of concerns. Testing philosophies like test-driven development and ensuring tests are fast, independent, repeatable, self-validating, and timely are also emphasized. The overall message is that writing clean code requires attention to structure, naming, formatting and testing to produce software that is simple, well-organized and a pleasure to maintain.
Clean code
"Even bad code can function. But if code isn't clean, it can bring a development organization to its knees. Every year, countless hours and significant resources are lost because of poorly written code. But it doesn't have to be that way." In this knolx session, a few important topics for having clean code are covered. Basically the following topics - Meaningful name, Functions, Comments and Classes.
Keeping code clean
One of the main hindrances to teams being able to respond rapidly to new features are technical problems resulting from bad coding practices, also known as technical debt. Melissa and Brett will cover Agile tools and practices that help development teams write better code and increase maintainability. Topics that will be covered include:
Pair programming
Automated Unit Testing
Refactoring
Test-Driven Development
Agile Architecture
DDD with Behat
The document discusses the evolution of agile teams from having no tests to implementing behavior-driven development and domain-driven design using Behat acceptance tests. It provides examples of using Behat scenarios to drive the development of a domain model for a messaging system without frameworks or controllers. The benefits are a simple, framework-agnostic domain model that is easy to understand and test and separates business logic from the user interface layers.
Are You Ready For Clean Code?
What, when, how, and for whom is clean code? It's just ordinary weekly devTalk material at Vox Teneo Indonesia.
clean code book summary - uncle bob - English version
The document provides guidance on writing clean code based on the book "Clean Code" by Robert Cecil Martin. Some of the key points discussed include:
- Functions should do one thing and do it well, with a single level of abstraction and no side effects. They should fit on a screen.
- Names should be meaningful, avoid abbreviations, and use consistent vocabulary. Class names should be nouns and method names should be verbs.
- Code formatting is important for readability. Classes should not exceed 200 lines, functions a single screen. Variables should be declared near use.
- Comments should only explain why unusual decisions were made, not what the code does. Avoid commented out code or redundant comments
Usable Software Design
How to improve software design by using UX mindset, techniques and practices, given that the user of software design is the developer.
Software Engineering Primer
Georg Buske provided an overview of essential software engineering topics for both small and large projects, including:
- Agile methodologies like Scrum, Kanban, and XP and how they can be applied to different sized projects.
- Software design principles like clean code, SOLID, DRY, KISS, and YAGNI and architectural styles like domain-driven design.
- The importance of documentation, standards, and guidelines for development processes, coding practices, and more within organizations.
- Additional topics on testing approaches like TDD, naming conventions, anti-patterns to avoid, and prioritizing simple, maintainable solutions.
Basic software engineering principles with code examples - Session 2
Software engineering principles include understanding requirements, planning solutions, examining results, and solving problems fully before implementation. The SOLID principles promote single responsibility, open/closed design, Liskov substitution, interface segregation, and dependency inversion. Naming conventions like descriptive variable and function names promote readability and maintainability. Code duplications should be avoided by applying principles like DRY, abstraction, and inheritance.
Clean Code
Overview of the most popular rules from the book "Clean Code: A Handbook of Agile Software Craftsmanship (2008) by Rober C. Martin.
AN EXERCISE IN CLEANER CODE - FROM LEGACY TO MAINTAINABLE
We’ve all had those projects, the salvage project, the legacy project that we picked up, and wished we never had.
Was it written 5 years ago by that young dev with lots of passion but no big picture vision.
Was it written 6 months ago by another team, by a top gun developer who knows all the design patterns, and tried to future proof the app, only succeeding in making it impossible for anyone else to understand.
Or was it you, 2 years ago, before you joined the community and learned more about best (better) practices and you almost cannot comprehend how you used to code.
Long story short, we have all been there, but the past is history, how do we proceed from here, that’s the key. We’ll look at some of the ways you can clean up your code, and walk through some examples, and walk the journey to software craftsmanship
5 main points
What is clean code
Reading vs Writing Code
Don’t suffocate your code, let it breathe
Simple & Self Documenting Code
Lower the Cognitive Load
AN EXERCISE IN CLEANER CODE - FROM LEGACY TO MAINTAINABLE - CFObjective() 2017
We’ve all had those projects, the salvage project, the legacy project that we picked up, and wished we never had.
Was it written 5 years ago by that young dev with lots of passion but no big picture vision.
Was it written 6 months ago by another team, by a top gun developer who knows all the design patterns, and tried to future proof the app, only succeeding in making it impossible for anyone else to understand.
Or was it you, 2 years ago, before you joined the community and learned more about best (better) practices and you almost cannot comprehend how you used to code.
Long story short, we have all been there, but the past is history, how do we proceed from here, that’s the key. We’ll look at some of the ways you can clean up your code, and walk through some examples, and walk the journey to software craftsmanship
5 main points
What is clean code
Reading vs Writing Code
Don’t suffocate your code, let it breathe
Simple & Self Documenting Code
Lower the Cognitive Load
Keeping business logic out of your UIs
This document discusses keeping business logic out of user interfaces (UIs) by separating the UI layer from the business logic layer. It recommends:
- Placing the transaction boundary between the UI and backend to minimize backend calls.
- Ensuring service layers are highly cohesive and avoid general "god services".
- Separating reading data (queries) from writing data (commands) to allow for optimizations.
- Avoiding CRUD-style UIs and services that move business logic into the user's head, and base UIs and services on actual business processes instead.
- Considering introducing a command-based architecture where commands and queries model business operations to further separate business logic from the UI.
TDD and Simple Design Workshop - Session 1 - March 2019
The document discusses test-driven development (TDD) and simple design. It introduces TDD and some of its core practices, including test-driven development, simple design, refactoring, and pair programming. It provides an agenda for a workshop that will cover these topics over three sessions, including extreme programming (XP), the four elements of simple design, test doubles, outside-in TDD, and SOLID principles. The workshop aims to communicate best practices for using technical practices to succeed with agile development.
Importance Of Being Driven
The importance to be Driven
There are many buzzwords and acronyms to describe how the software should be designed. TDD (Test Driven), BDD (Behaviour Driven), DDD (Domain Driven) are the most well known. In this speech we'll run thought all these techniques comparing each one of those with TDD and finding what are the common concepts. An exercise will show to the students how different the code will be using different design methodologies as driver.
Clean Code - Writing code for human
This document provides an outline for a course on clean code. It covers principles of clean code like high signal-to-noise ratio, self-documenting code, and the right tool for the job. It also discusses techniques for writing clean code, such as naming conventions, writing high-quality functions and classes, using conditionals effectively, and using comments judiciously. The document is presented over several pages with headings and subheadings to structure the content.
Think components. March 2017
How to architect and build software components.
Improve your understanding of software components and how to architect and build them.
Examples assume familiarity with React.
Similar to CLEAN CODE (20)
clean code book summary - uncle bob - English version
clean code book summary - uncle bob - English version
Basic software engineering principles with code examples - Session 2
Basic software engineering principles with code examples - Session 2
AN EXERCISE IN CLEANER CODE - FROM LEGACY TO MAINTAINABLE
AN EXERCISE IN CLEANER CODE - FROM LEGACY TO MAINTAINABLE
AN EXERCISE IN CLEANER CODE - FROM LEGACY TO MAINTAINABLE - CFObjective() 2017
AN EXERCISE IN CLEANER CODE - FROM LEGACY TO MAINTAINABLE - CFObjective() 2017
TDD and Simple Design Workshop - Session 1 - March 2019
TDD and Simple Design Workshop - Session 1 - March 2019
More from Knoldus Inc.
Terratest - Automation testing of infrastructure
TerraTest is a testing framework specifically designed for testing infrastructure code written with HashiCorp's Terraform. It helps validate that your Terraform configurations create the desired infrastructure, and it can be used for both unit testing and integration testing.
Getting Started with Apache Spark (Scala)
In this session, we are going to cover Apache Spark, the architecture of Apache Spark, Data Lineage, Direct Acyclic Graph(DAG), and many more concepts. Apache Spark is a multi-language engine for executing data engineering, data science, and machine learning on single-node machines or clusters.
Secure practices with dot net services.pptx
Securing .NET services is paramount for protecting applications and data. Employing encryption, strong authentication, and adherence to best coding practices ensures resilience against potential threats, enhancing overall cybersecurity posture.
Distributed Cache with dot microservices
A distributed cache is a cache shared by multiple app servers, typically maintained as an external service to the app servers that access it. A distributed cache can improve the performance and scalability of an ASP.NET Core app, especially when the app is hosted by a cloud service or a server farm. Here we will look into implementation of Distributed Caching Strategy with Redis in Microservices Architecture focusing on cache synchronization, eviction policies, and cache consistency.
Introduction to gRPC Presentation (Java)
gRPC, which stands for Remote Procedure Call, is an open-source framework developed by Google. It is designed for building efficient and scalable distributed systems. gRPC enables communication between client and server applications by defining a set of services and message types using Protocol Buffers (protobuf) as the interface definition language. gRPC provides a way for applications to call methods on a remote server as if they were local procedures, making it a powerful tool for building distributed and microservices-based architectures.
Using InfluxDB for real-time monitoring in Jmeter
Explore the integration of InfluxDB with JMeter for real-time performance monitoring. This session will cover setting up InfluxDB to capture JMeter metrics, configuring JMeter to send data to InfluxDB, and visualizing the results using Grafana. Learn how to leverage this powerful combination to gain real-time insights into your application's performance, enabling proactive issue detection and faster resolution.
Intoduction to KubeVela Presentation (DevOps)
KubeVela is an open-source platform for modern application delivery and operation on Kubernetes. It is designed to simplify the deployment and management of applications in a Kubernetes environment. KubeVela is a modern software delivery platform that makes deploying and operating applications across today's hybrid, multi-cloud environments easier, faster and more reliable. KubeVela is infrastructure agnostic, programmable, yet most importantly, application-centric. It allows you to build powerful software, and deliver them anywhere!
Stakeholder Management (Project Management) Presentation
A stakeholder is someone who has an interest in or who is affected by your project and its outcome. This may include both internal and external entities such as the members of the project team, project sponsors, executives, customers, suppliers, partners and the government. Stakeholder management is the process of managing the expectations and the requirements of these stakeholders.
Introduction To Kaniko (DevOps) Presentation
Kaniko is an open-source tool developed by Google that enables building container images from a Dockerfile inside a Kubernetes cluster without requiring a Docker daemon. Kaniko executes each command in the Dockerfile in the user space using an executor image, which runs inside a container, such as a Kubernetes pod. This allows building container images in environments where the user doesn’t have root access, like a Kubernetes cluster.
Efficient Test Environments with Infrastructure as Code (IaC)
In the rapidly evolving landscape of software development, the need for efficient and scalable test environments has become more critical than ever. This session, "Streamlining Development: Unlocking Efficiency through Infrastructure as Code (IaC) in Test Environments," is designed to provide an in-depth exploration of how leveraging IaC can revolutionize your testing processes and enhance overall development productivity.
Exploring Terramate DevOps (Presentation)
Terramate is a code generator and orchestrator for Terraform that enhances Terraform's capabilities by adding features such as code generation, stacks, orchestration, change detection, globals, and more . It's primarily designed to help manage Terraform code at scale more efficiently . Terramate is particularly useful for managing multiple Terraform stacks, providing support for change detection and code generation 2. It allows you to create relationships between stacks to improve your understanding and control over your infrastructure . One of the key features of Terramate is its ability to detect changes at both the stack and module level. This capability allows you to identify which stacks and resources have been altered and selectively determine where you should execute commands.
Clean Code in Test Automation Differentiating Between the Good and the Bad
This session focuses on the principles of writing clean, maintainable, and efficient code in the context of test automation. The session will highlight the characteristics that distinguish good test automation code from bad, ultimately leading to more reliable and scalable testing frameworks.
Integrating AI Capabilities in Test Automation
Explore the integration of artificial intelligence in test automation. Understand how AI can enhance test planning, execution, and analysis, leading to more efficient and reliable testing processes. Explore the cutting-edge integration of Artificial Intelligence (AI) capabilities in Test Automation, a transformative approach shaping the future of software testing. This session will delve into practical applications, benefits, and considerations associated with infusing AI into test automation workflows.
State Management with NGXS in Angular.pptx
NGXS is a state management pattern and library for Angular. NGXS acts as a single source of truth for your application's state - providing simple rules for predictable state mutations. In this session we will go through the main for components of NGXS -Store, Actions, State, and Select.
Authentication in Svelte using cookies.pptx
Svelte streamlines authentication with cookies, offering a secure and seamless user experience. Effortlessly manage sessions by storing tokens in cookies, ensuring persistent logins. With Svelte's simplicity, implement robust authentication mechanisms, enhancing user security and interaction.
OAuth2 Implementation Presentation (Java)
The OAuth 2.0 authorization framework is a protocol that allows a user to grant a third-party web site or application access to the user's protected resources, without necessarily revealing their long-term credentials or even their identity. It is commonly used in scenarios such as user authentication in web and mobile applications and enables a more secure and user-friendly authorization process.
Supply chain security with Kubeclarity.pptx
Kube clarity is a comprehensive solution designed to enhance supply chain security within Kubernetes environments. Kube clarity enables organizations to identify and mitigate potential security threats throughout the software development and deployment process.
Mastering Web Scraping with JSoup Unlocking the Secrets of HTML Parsing
In this session, we will delve into the world of web scraping with JSoup, an open-source Java library. Here we are going to learn how to parse HTML effectively, extract meaningful data, and navigate the Document Object Model (DOM) for powerful web scraping capabilities.
Akka gRPC Essentials A Hands-On Introduction
Dive into the fundamental aspects of Akka gRPC and learn to leverage its power in building compact and efficient distributed systems. This session aims to equip attendees with the essential skills and knowledge to leverage Akka and gRPC effectively in building robust, scalable, and distributed applications.
Entity Core with Core Microservices.pptx
How Developers can use Entity framework(ORM) which provides a structured and consistent way for microservices to interact with their respective database, prompting independence, scaliblity and maintainiblity in a distributed system, and also provide a high-level abstraction for data access.
More from Knoldus Inc. (20)
Stakeholder Management (Project Management) Presentation
Stakeholder Management (Project Management) Presentation
Efficient Test Environments with Infrastructure as Code (IaC)
Efficient Test Environments with Infrastructure as Code (IaC)
Clean Code in Test Automation Differentiating Between the Good and the Bad
Clean Code in Test Automation Differentiating Between the Good and the Bad
Mastering Web Scraping with JSoup Unlocking the Secrets of HTML Parsing
Mastering Web Scraping with JSoup Unlocking the Secrets of HTML Parsing
Recently uploaded
socradar-q1-2024-aviation-industry-report.pdf
SOCRadar's Aviation Industry Q1 Incident Report is out now!
The aviation industry has always been a prime target for cybercriminals due to its critical infrastructure and high stakes. In the first quarter of 2024, the sector faced an alarming surge in cybersecurity threats, revealing its vulnerabilities and the relentless sophistication of cyber attackers.
SOCRadar’s Aviation Industry, Quarterly Incident Report, provides an in-depth analysis of these threats, detected and examined through our extensive monitoring of hacker forums, Telegram channels, and dark web platforms.
Webinar On-Demand: Using Flutter for Embedded
Flutter is a popular open source, cross-platform framework developed by Google. In this webinar we'll explore Flutter and its architecture, delve into the Flutter Embedder and Flutter’s Dart language, discover how to leverage Flutter for embedded device development, learn about Automotive Grade Linux (AGL) and its consortium and understand the rationale behind AGL's choice of Flutter for next-gen IVI systems. Don’t miss this opportunity to discover whether Flutter is right for your project.
Artificia Intellicence and XPath Extension Functions
The purpose of this presentation is to provide an overview of how you can use AI from XSLT, XQuery, Schematron, or XML Refactoring operations, the potential benefits of using AI, and some of the challenges we face.
GreenCode-A-VSCode-Plugin--Dario-Jurisic
Presentation about a VSCode plugin from Dario Jurisic at the GSD Community Stage meetup
A Study of Variable-Role-based Feature Enrichment in Neural Models of Code
Understanding variable roles in code has been found to be helpful by students
in learning programming -- could variable roles help deep neural models in
performing coding tasks? We do an exploratory study.
- These are slides of the talk given at InteNSE'23: The 1st International Workshop on Interpretability and Robustness in Neural Software Engineering, co-located with the 45th International Conference on Software Engineering, ICSE 2023, Melbourne Australia
How to write a program in any programming language
How to write a program in any programming language
What is Master Data Management by PiLog Group
PiLog Group's Master Data Record Manager (MDRM) is a sophisticated enterprise solution designed to ensure data accuracy, consistency, and governance across various business functions. MDRM integrates advanced data management technologies to cleanse, classify, and standardize master data, thereby enhancing data quality and operational efficiency.
Hand Rolled Applicative User Validation Code Kata
Could you use a simple piece of Scala validation code (granted, a very simplistic one too!) that you can rewrite, now and again, to refresh your basic understanding of Applicative operators <*>, <*, *>?
The goal is not to write perfect code showcasing validation, but rather, to provide a small, rough-and ready exercise to reinforce your muscle-memory.
Despite its grandiose-sounding title, this deck consists of just three slides showing the Scala 3 code to be rewritten whenever the details of the operators begin to fade away.
The code is my rough and ready translation of a Haskell user-validation program found in a book called Finding Success (and Failure) in Haskell - Fall in love with applicative functors.
Need for Speed: Removing speed bumps from your Symfony projects ⚡️
No one wants their application to drag like a car stuck in the slow lane! Yet it’s all too common to encounter bumpy, pothole-filled solutions that slow the speed of any application. Symfony apps are not an exception.
In this talk, I will take you for a spin around the performance racetrack. We’ll explore common pitfalls - those hidden potholes on your application that can cause unexpected slowdowns. Learn how to spot these performance bumps early, and more importantly, how to navigate around them to keep your application running at top speed.
We will focus in particular on tuning your engine at the application level, making the right adjustments to ensure that your system responds like a well-oiled, high-performance race car.
Using Xen Hypervisor for Functional Safety
An update on making Xen hypervisor functionally safe and enhancing its usage in automotive and industrial use cases
Essentials of Automations: The Art of Triggers and Actions in FME
In this second installment of our Essentials of Automations webinar series, we’ll explore the landscape of triggers and actions, guiding you through the nuances of authoring and adapting workspaces for seamless automations. Gain an understanding of the full spectrum of triggers and actions available in FME, empowering you to enhance your workspaces for efficient automation.
We’ll kick things off by showcasing the most commonly used event-based triggers, introducing you to various automation workflows like manual triggers, schedules, directory watchers, and more. Plus, see how these elements play out in real scenarios.
Whether you’re tweaking your current setup or building from the ground up, this session will arm you with the tools and insights needed to transform your FME usage into a powerhouse of productivity. Join us to discover effective strategies that simplify complex processes, enhancing your productivity and transforming your data management practices with FME. Let’s turn complexity into clarity and make your workspaces work wonders!
8 Best Automated Android App Testing Tool and Framework in 2024.pdf
Regarding mobile operating systems, two major players dominate our thoughts: Android and iPhone. With Android leading the market, software development companies are focused on delivering apps compatible with this OS. Ensuring an app's functionality across various Android devices, OS versions, and hardware specifications is critical, making Android app testing essential.
What is Augmented Reality Image Tracking
Augmented Reality (AR) Image Tracking is a technology that enables AR applications to recognize and track images in the real world, overlaying digital content onto them. This enhances the user's interaction with their environment by providing additional information and interactive elements directly tied to physical images.
UI5con 2024 - Boost Your Development Experience with UI5 Tooling Extensions
The UI5 tooling is the development and build tooling of UI5. It is built in a modular and extensible way so that it can be easily extended by your needs. This session will showcase various tooling extensions which can boost your development experience by far so that you can really work offline, transpile your code in your project to use even newer versions of EcmaScript (than 2022 which is supported right now by the UI5 tooling), consume any npm package of your choice in your project, using different kind of proxies, and even stitching UI5 projects during development together to mimic your target environment.
Neo4j - Product Vision and Knowledge Graphs - GraphSummit Paris
Dr. Jesús Barrasa, Head of Solutions Architecture for EMEA, Neo4j
Découvrez les dernières innovations de Neo4j, et notamment les dernières intégrations cloud et les améliorations produits qui font de Neo4j un choix essentiel pour les développeurs qui créent des applications avec des données interconnectées et de l’IA générative.
UI5con 2024 - Keynote: Latest News about UI5 and it’s Ecosystem
Learn about the latest innovations in and around OpenUI5/SAPUI5: UI5 Tooling, UI5 linter, UI5 Web Components, Web Components Integration, UI5 2.x, UI5 GenAI.
Recording:
https://www.youtube.com/live/MSdGLG2zLy8?si=INxBHTqkwHhxV5Ta&t=0
AI Fusion Buddy Review: Brand New, Groundbreaking Gemini-Powered AI App
AI Fusion Buddy Review: Brand New, Groundbreaking Gemini-Powered AI App
👉👉 Click Here To Get More Info 👇👇
https://sumonreview.com/ai-fusion-buddy-review
AI Fusion Buddy Review: Key Features
✅Create Stunning AI App Suite Fully Powered By Google's Latest AI technology, Gemini
✅Use Gemini to Build high-converting Converting Sales Video Scripts, ad copies, Trending Articles, blogs, etc.100% unique!
✅Create Ultra-HD graphics with a single keyword or phrase that commands 10x eyeballs!
✅Fully automated AI articles bulk generation!
✅Auto-post or schedule stunning AI content across all your accounts at once—WordPress, Facebook, LinkedIn, Blogger, and more.
✅With one keyword or URL, generate complete websites, landing pages, and more…
✅Automatically create & sell AI content, graphics, websites, landing pages, & all that gets you paid non-stop 24*7.
✅Pre-built High-Converting 100+ website Templates and 2000+ graphic templates logos, banners, and thumbnail images in Trending Niches.
✅Say goodbye to wasting time logging into multiple Chat GPT & AI Apps once & for all!
✅Save over $5000 per year and kick out dependency on third parties completely!
✅Brand New App: Not available anywhere else!
✅ Beginner-friendly!
✅ZERO upfront cost or any extra expenses
✅Risk-Free: 30-Day Money-Back Guarantee!
✅Commercial License included!
See My Other Reviews Article:
(1) AI Genie Review: https://sumonreview.com/ai-genie-review
(2) SocioWave Review: https://sumonreview.com/sociowave-review
(3) AI Partner & Profit Review: https://sumonreview.com/ai-partner-profit-review
(4) AI Ebook Suite Review: https://sumonreview.com/ai-ebook-suite-review
#AIFusionBuddyReview,
#AIFusionBuddyFeatures,
#AIFusionBuddyPricing,
#AIFusionBuddyProsandCons,
#AIFusionBuddyTutorial,
#AIFusionBuddyUserExperience
#AIFusionBuddyforBeginners,
#AIFusionBuddyBenefits,
#AIFusionBuddyComparison,
#AIFusionBuddyInstallation,
#AIFusionBuddyRefundPolicy,
#AIFusionBuddyDemo,
#AIFusionBuddyMaintenanceFees,
#AIFusionBuddyNewbieFriendly,
#WhatIsAIFusionBuddy?,
#HowDoesAIFusionBuddyWorks
Unveiling the Advantages of Agile Software Development.pdf
Learn about Agile Software Development's advantages. Simplify your workflow to spur quicker innovation. Jump right in! We have also discussed the advantages.
SMS API Integration in Saudi Arabia| Best SMS API Service
Discover the benefits and implementation of SMS API integration in the UAE and Middle East. This comprehensive guide covers the importance of SMS messaging APIs, the advantages of bulk SMS APIs, and real-world case studies. Learn how CEQUENS, a leader in communication solutions, can help your business enhance customer engagement and streamline operations with innovative CPaaS, reliable SMS APIs, and omnichannel solutions, including WhatsApp Business. Perfect for businesses seeking to optimize their communication strategies in the digital age.
Oracle Database 19c New Features for DBAs and Developers.pptx
Oracle Database 19c New Features for DBAs and Developers. This video you can watch from my youtube channel at https://youtu.be/m-F-mZA3MkU
Recently uploaded (20)
Artificia Intellicence and XPath Extension Functions
Artificia Intellicence and XPath Extension Functions
A Study of Variable-Role-based Feature Enrichment in Neural Models of Code
A Study of Variable-Role-based Feature Enrichment in Neural Models of Code
How to write a program in any programming language
How to write a program in any programming language
Need for Speed: Removing speed bumps from your Symfony projects ⚡️
Need for Speed: Removing speed bumps from your Symfony projects ⚡️
Essentials of Automations: The Art of Triggers and Actions in FME
Essentials of Automations: The Art of Triggers and Actions in FME
8 Best Automated Android App Testing Tool and Framework in 2024.pdf
8 Best Automated Android App Testing Tool and Framework in 2024.pdf
UI5con 2024 - Boost Your Development Experience with UI5 Tooling Extensions
UI5con 2024 - Boost Your Development Experience with UI5 Tooling Extensions
Neo4j - Product Vision and Knowledge Graphs - GraphSummit Paris
Neo4j - Product Vision and Knowledge Graphs - GraphSummit Paris
UI5con 2024 - Keynote: Latest News about UI5 and it’s Ecosystem
UI5con 2024 - Keynote: Latest News about UI5 and it’s Ecosystem
AI Fusion Buddy Review: Brand New, Groundbreaking Gemini-Powered AI App
AI Fusion Buddy Review: Brand New, Groundbreaking Gemini-Powered AI App
Unveiling the Advantages of Agile Software Development.pdf
Unveiling the Advantages of Agile Software Development.pdf
SMS API Integration in Saudi Arabia| Best SMS API Service
SMS API Integration in Saudi Arabia| Best SMS API Service
Oracle Database 19c New Features for DBAs and Developers.pptx
Oracle Database 19c New Features for DBAs and Developers.pptx
CLEAN CODE
- 1. CLEAN CODE Ramandeep Kaur Software Consultant Knoldus Inc.
- 2. Agenda ● Motivation ● What is Clean Code? ● Meaningful Names ● Functions ● Objects and Data Structures ● Error Handling ● Demo
- 3. BAD CODE ● Go fast? ● Angry Boss? ● Tired of Project? ● Get working now, clean up later? ● Everybody does it!
- 4. What is Clean Code?
- 7. Meaningful Names ● Variables, functions, class names should answer all the big questions: ~ why it exists? ~ what it does? ~ how it is used?
- 8. ● If a name requires a comment, then the name doesn’t reveal its intent. int d; // elapsed time In days ● Avoid Disinformation - don’t use type information in names personList
- 9. ~> Don’t be afraid to make a name long. A long descriptive name is better than a short enigmatic name. ~> A long descriptive name is better than a long descriptive comment.
- 10. What is the purpose of this code?
- 11. Refactored code
- 12. FUNCTIONS
- 13. FUNCTIONS ● Small < 150 characters per line < 20 lines ● Arguments Number of arguments: as minimum as possible Avoid output arguments
- 14. Side Effects are Lies!
- 15. Do one thing!
- 17. OBJECTS ● Hide data and expose functions ● Easy to add new objects ● Hard to add new behaviors
- 19. DATA STRUCTURES ● Expose data and have no meaningful functions ● Easy to add new behaviors ● Hard to add new data structures Choose the approach that is best for the job.
- 21. The Law of Demeter
- 22. The Law of Demeter ● It says our function should only access the classes/objects that it has direct access to which are: i. Objects in class parameter ii. Object in function parameter iii. Object in class members iv. Objects created inside function body.
- 23. Examples ● In short, the Law of Demeter aims to keep you from doing things like this: objectA.getObjectB().doSomething(); or even worse, this: objectA.getObjectB().getObjectC().doSomething();
- 24. ERROR HANDLING
- 25. ERROR HANDLING ● Write code that is clean ● See error handling as a separate concern ● Use exception rather than return codes
- 26. DEMO Talk is easy, show me the CODE!
- 27. Thank You