Clean code and Coding Standards
•Download as PPTX, PDF•
1 like•987 views
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.
Report
Share
Report
Share
Recommended
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
Clean Code summary
Presentation I held before my colleagues about the book Clean Code (http://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882).
It contains the highlights of several chapters and hint/guidelines a developer should know.
Writing clean and maintainable code
Writing code is easy but writing maintainable code is almost impossible. During this talk I will discuss some of the principles of coding that relates to WordPress but goes beyond that.
How To Become A Good C# Programmer
In this whitepaper, LearnItFirst founder Scott Whigham talks about how you can become a good (or better) C# programmer. This whitepaper is long - 15 pages - but it includes both a step-by-step system to follow as well as an in-depth discussion of each step.
If you follow this 13-step system (with a bonus 14th step), you can’t help but become a good C# developer!
Software development best practices & coding guidelines
Software development best practices & coding guidelines. How to write maintainable, readable code. Following coding standards
WordCamp US: Clean Code
We want code that is easy to understand, re-usable, and flexible. But we are always up against deadlines, so we rush, and end up with code that is messy, buggy, hard to maintain, and makes us go slower even though we’re trying to go faster.
What is clean code? In this talk I’ll provide some answers to this question, and introduce you to 10 good habits that will help keep your code clean, such as the use of meaningful names for your variables and functions, and following the “Boy Scout Rule” (leave the code cleaner than you found it). I will even try to persuade you that using a lot of code comments is a sign that there are problems with your code.
How to get the most out of code reviews
As developers we always look for ways to do things faster, better, and automate as much as possible. We write code in top-notch IDEs that have static code analysis, automatic refactoring and so on, we run unit tests, we use CI servers, and issue trackers, we adopt agile practices to get feedback and deliver as fast as possible. As far as code review practice goes, there’s still a lot to be improved, and in this talk I’m going to tell you how you can perform efficient, transparent and useful code reviews.
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.
Recommended
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
Clean Code summary
Presentation I held before my colleagues about the book Clean Code (http://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882).
It contains the highlights of several chapters and hint/guidelines a developer should know.
Writing clean and maintainable code
Writing code is easy but writing maintainable code is almost impossible. During this talk I will discuss some of the principles of coding that relates to WordPress but goes beyond that.
How To Become A Good C# Programmer
In this whitepaper, LearnItFirst founder Scott Whigham talks about how you can become a good (or better) C# programmer. This whitepaper is long - 15 pages - but it includes both a step-by-step system to follow as well as an in-depth discussion of each step.
If you follow this 13-step system (with a bonus 14th step), you can’t help but become a good C# developer!
Software development best practices & coding guidelines
Software development best practices & coding guidelines. How to write maintainable, readable code. Following coding standards
WordCamp US: Clean Code
We want code that is easy to understand, re-usable, and flexible. But we are always up against deadlines, so we rush, and end up with code that is messy, buggy, hard to maintain, and makes us go slower even though we’re trying to go faster.
What is clean code? In this talk I’ll provide some answers to this question, and introduce you to 10 good habits that will help keep your code clean, such as the use of meaningful names for your variables and functions, and following the “Boy Scout Rule” (leave the code cleaner than you found it). I will even try to persuade you that using a lot of code comments is a sign that there are problems with your code.
How to get the most out of code reviews
As developers we always look for ways to do things faster, better, and automate as much as possible. We write code in top-notch IDEs that have static code analysis, automatic refactoring and so on, we run unit tests, we use CI servers, and issue trackers, we adopt agile practices to get feedback and deliver as fast as possible. As far as code review practice goes, there’s still a lot to be improved, and in this talk I’m going to tell you how you can perform efficient, transparent and useful code reviews.
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.
Documenting code yapceu2016
How do we document code? A good solution is to create self-explanatory code; this somewhat eliminates the need to document the code. We still need some very basic documentation. Code comments are one form of documentation, that is often misused. This talk is about self-explanatory code, the documentation we need and code comment patterns and anti-patterns.
Naming Standards, Clean Code
Meaningful variable and function names are important for clean code. Names should clearly indicate what the variable or function represents. Names like "temp", "x", or "flag" should generally be avoided as they do not convey purpose. Instead, names should be searchable and pronounceable terms from the problem domain. Additional context can be added through classes, namespaces, or prefixes if needed. Names of a moderate length, between 8-20 characters on average, tend to balance readability and understandability.
TDD — Are you sure you properly test code?
This document discusses best practices for test-driven development (TDD). It begins by describing the different types of tests - unit, integration, and acceptance. It then discusses the debate around having more unit tests vs acceptance tests. The document argues that less acceptance tests and more unit tests leads to faster, higher quality code. The rest of the document outlines five rules for writing effective tests: 1) Write tests before coding, 2) Don't test everything, 3) Test only public APIs, 4) Don't create extra getters for testing, and 5) Listen to what your tests are telling you about your code quality and design.
Code Review Matters and Manners
A code review is basically a technical discussion which should lead to improvements in the code and/or sharing
knowledge in a team. As with any conversation, it should have substance and form.
What’s involved in a good code review? What kind of problems do we want to spot and address? Trisha Gee will talk
about things a reviewer may consider when looking at changes: what potential issues to look for; why certain
patterns may be harmful; and, of course, what NOT to look at.
But when it comes to commenting on someone’s work, it may be hard to find the right words to convey a useful message
without offending the authors - after all, this is something that they worked hard on. Maria Khalusova will share
some observations, thoughts and practical tricks on how to give and receive feedback without turning a code review
into a battlefield.
高品質軟體的基本動作 101 for NTHU
This document discusses guidelines for writing high quality code, including definitions of code quality, examples of good and bad practices for variables and statements, and recommendations on code construction. It focuses on concepts from the book "Code Complete" such as self-documenting code, managing complexity, information hiding, and creating high-level abstractions through classes and routines. The presentation provides many examples and recommendations for writing understandable, maintainable and flexible code.
Documenting Code - Patterns and Anti-patterns - NLPW 2016
How do we document code? A good solution is to create self-explanatory code; this somewhat eliminates the need to document the code. We still need some very basic documentation. Code comments are one form of documentation, that is often misused. This talk is about self-explanatory code, the documentation we need and code comment patterns and anti-patterns.
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.
Code Review for iOS
Hi I’m Cris, iOS Developer in KLabCyscorpions. In this post, I want to share with you my presentation on Code Review guidelines for iOS.
But, what is Code Review?
According to Wikipedia:
“Code Review is systematic examination (often known as peer review) of computer source code. It is intended to find and fix mistakes overlooked in the initial development phase, improving both the overall quality of software and the developers’ skills. Reviews are done in various forms such as pair programming, informal walkthroughs, and formal inspections.”
Want to review code? Then First things first! For you to review code effectively, you need the basic know-how of reviewing code as both the developer and the reviewer. These slides will give some guidelines on how to think in both these roles when reviewing code.
Code reviews
The document discusses best practices for code reviews. It notes that code reviews should be collaborative, focus on the code quality and functionality rather than personal critiques, and maintain a constructive environment. Effective code review methods include pair programming for continuous feedback, pull requests to facilitate discussion, and focusing comments on improving code rather than criticizing authors. The goal is to maximize productivity while ensuring code quality.
CLEAN CODE
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.
Designing with tests
Unit tests are great, they help a developer gain control over his code and catch bugs and regression issues.
Test Driven Development is a methodology that uses unit tests but it's not about writing unit tests - in fact the tests are only a design tool.
TDD is a methodology that solves problems in an iterative way, it's about emergent design that creates a maintainable solution.
In this session I'll talk about common mistakes and misconceptions, how to benefit from TDD and show how to design your code using unit tests.
The code for this talk can be found on GitHub: https://github.com/dhelper/DesignWIthTests
Code smells and Other Malodorous Software Odors
This document discusses code smells, which are surface indications in source code that typically correspond to deeper problems in the system. It defines several common code smells such as duplicate code, large methods, magic numbers, dead code, and speculative code. The document provides explanations of these smells and recommendations for addressing them, such as extracting duplicated code into methods, breaking large classes into smaller focused classes, and avoiding checking in experimental code. It notes that code smells often arise from issues like haste, apathy, and ignorance when developing code.
How to write maintainable code - Peter Hilton - Codemotion Amsterdam 2017
The problem that new technology doesn’t fix is unmaintainable code. Clean code with good tests is essential, but not enough. This talk introduces techniques like getting better at naming, explaining code with tests, the few code comments you actually need, README-driven development and writing Minimum Viable Documentation. After the excitement of adopting new technology and software craftsmanship comes the horror of your next software maintenance project. As Jean-Paul Sartre said*, ‘Hell is other people’s code’. Whatever your level, your future happiness depends on maintainable code.
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.
Beyond Unit Testing
This document discusses going beyond unit testing for web applications. It introduces several tools for testing different aspects of web applications, including Selenium IDE for browser-based testing, soapUI for web service testing, and JMeter for performance and load testing. These tools can be run from the command line as part of continuous integration with Jenkins. The document cites research that unit testing only detects an average of 25% of defects, while integration testing detects 45%, and code reviews have even higher effectiveness rates.
Cracking the coding interview u penn - sept 30 2010
1) The document provides an overview of the technical interview process at large tech companies and advice on how to prepare. It discusses the typical interview structure, what companies look for, and red flags.
2) It recommends getting hands-on coding experience through projects, open source contributions, or part-time work. The author's company CareerCup provides technical interview preparation resources.
3) Key tips for the interview include practicing common algorithms and data structures, thinking out loud, testing code thoroughly, and maintaining a positive attitude even if you make a mistake. Pattern matching prior problems and simplifying the problem are suggested approaches.
Clean Code, Resumen Capítulo 1.
Resumen del capítulo 1 del libro de Robert C. Martin:
Clean code: a handbook of agile software craftsmanship. Upper Saddle River, NJ: Prentice Hall
Para la clase Gestión de Calidad de Software. Universidad Pontificia Bolivariana, Medellín 2016
Why coding convention ?
Coding conventions provide guidelines for programming style, practices, and naming to make code more consistent, easier to understand, and maintainable. They set standards for indentation, brace style, naming conventions, and other aspects so that collaborators can work together effectively and consistently. While different styles can work, it is important for a team to agree on and stick to shared conventions.
Level Up Your Automated Tests
The document discusses ways to improve automated testing practices, such as by making tests easier to write, more readable, and more meaningful. It suggests using mocking frameworks to reduce test complexity, following standards and examples, and adopting a testing framework like Spock that addresses common issues. While progress has been made, there is still work to be done to encourage writing tests, make tests easy to write and understand, and ensure tests are meaningful and focused on the purposes of testing.
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
Coding standards
Coding standards are the standards required while programming to increase reliability,efficiency and maintenance of software.
Clean Code
The document discusses the principles of clean code as outlined in the book "Clean Code" by Robert C. Martin. It covers topics like meaningful names, comments, functions, objects and data structures, error handling, and unit tests. The goal of clean code is to produce readable, maintainable code through practices like breaking code into small, single-purpose functions and hiding implementation details in objects.
More Related Content
What's hot
Documenting code yapceu2016
How do we document code? A good solution is to create self-explanatory code; this somewhat eliminates the need to document the code. We still need some very basic documentation. Code comments are one form of documentation, that is often misused. This talk is about self-explanatory code, the documentation we need and code comment patterns and anti-patterns.
Naming Standards, Clean Code
Meaningful variable and function names are important for clean code. Names should clearly indicate what the variable or function represents. Names like "temp", "x", or "flag" should generally be avoided as they do not convey purpose. Instead, names should be searchable and pronounceable terms from the problem domain. Additional context can be added through classes, namespaces, or prefixes if needed. Names of a moderate length, between 8-20 characters on average, tend to balance readability and understandability.
TDD — Are you sure you properly test code?
This document discusses best practices for test-driven development (TDD). It begins by describing the different types of tests - unit, integration, and acceptance. It then discusses the debate around having more unit tests vs acceptance tests. The document argues that less acceptance tests and more unit tests leads to faster, higher quality code. The rest of the document outlines five rules for writing effective tests: 1) Write tests before coding, 2) Don't test everything, 3) Test only public APIs, 4) Don't create extra getters for testing, and 5) Listen to what your tests are telling you about your code quality and design.
Code Review Matters and Manners
A code review is basically a technical discussion which should lead to improvements in the code and/or sharing
knowledge in a team. As with any conversation, it should have substance and form.
What’s involved in a good code review? What kind of problems do we want to spot and address? Trisha Gee will talk
about things a reviewer may consider when looking at changes: what potential issues to look for; why certain
patterns may be harmful; and, of course, what NOT to look at.
But when it comes to commenting on someone’s work, it may be hard to find the right words to convey a useful message
without offending the authors - after all, this is something that they worked hard on. Maria Khalusova will share
some observations, thoughts and practical tricks on how to give and receive feedback without turning a code review
into a battlefield.
高品質軟體的基本動作 101 for NTHU
This document discusses guidelines for writing high quality code, including definitions of code quality, examples of good and bad practices for variables and statements, and recommendations on code construction. It focuses on concepts from the book "Code Complete" such as self-documenting code, managing complexity, information hiding, and creating high-level abstractions through classes and routines. The presentation provides many examples and recommendations for writing understandable, maintainable and flexible code.
Documenting Code - Patterns and Anti-patterns - NLPW 2016
How do we document code? A good solution is to create self-explanatory code; this somewhat eliminates the need to document the code. We still need some very basic documentation. Code comments are one form of documentation, that is often misused. This talk is about self-explanatory code, the documentation we need and code comment patterns and anti-patterns.
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.
Code Review for iOS
Hi I’m Cris, iOS Developer in KLabCyscorpions. In this post, I want to share with you my presentation on Code Review guidelines for iOS.
But, what is Code Review?
According to Wikipedia:
“Code Review is systematic examination (often known as peer review) of computer source code. It is intended to find and fix mistakes overlooked in the initial development phase, improving both the overall quality of software and the developers’ skills. Reviews are done in various forms such as pair programming, informal walkthroughs, and formal inspections.”
Want to review code? Then First things first! For you to review code effectively, you need the basic know-how of reviewing code as both the developer and the reviewer. These slides will give some guidelines on how to think in both these roles when reviewing code.
Code reviews
The document discusses best practices for code reviews. It notes that code reviews should be collaborative, focus on the code quality and functionality rather than personal critiques, and maintain a constructive environment. Effective code review methods include pair programming for continuous feedback, pull requests to facilitate discussion, and focusing comments on improving code rather than criticizing authors. The goal is to maximize productivity while ensuring code quality.
CLEAN CODE
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.
Designing with tests
Unit tests are great, they help a developer gain control over his code and catch bugs and regression issues.
Test Driven Development is a methodology that uses unit tests but it's not about writing unit tests - in fact the tests are only a design tool.
TDD is a methodology that solves problems in an iterative way, it's about emergent design that creates a maintainable solution.
In this session I'll talk about common mistakes and misconceptions, how to benefit from TDD and show how to design your code using unit tests.
The code for this talk can be found on GitHub: https://github.com/dhelper/DesignWIthTests
Code smells and Other Malodorous Software Odors
This document discusses code smells, which are surface indications in source code that typically correspond to deeper problems in the system. It defines several common code smells such as duplicate code, large methods, magic numbers, dead code, and speculative code. The document provides explanations of these smells and recommendations for addressing them, such as extracting duplicated code into methods, breaking large classes into smaller focused classes, and avoiding checking in experimental code. It notes that code smells often arise from issues like haste, apathy, and ignorance when developing code.
How to write maintainable code - Peter Hilton - Codemotion Amsterdam 2017
The problem that new technology doesn’t fix is unmaintainable code. Clean code with good tests is essential, but not enough. This talk introduces techniques like getting better at naming, explaining code with tests, the few code comments you actually need, README-driven development and writing Minimum Viable Documentation. After the excitement of adopting new technology and software craftsmanship comes the horror of your next software maintenance project. As Jean-Paul Sartre said*, ‘Hell is other people’s code’. Whatever your level, your future happiness depends on maintainable code.
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.
Beyond Unit Testing
This document discusses going beyond unit testing for web applications. It introduces several tools for testing different aspects of web applications, including Selenium IDE for browser-based testing, soapUI for web service testing, and JMeter for performance and load testing. These tools can be run from the command line as part of continuous integration with Jenkins. The document cites research that unit testing only detects an average of 25% of defects, while integration testing detects 45%, and code reviews have even higher effectiveness rates.
Cracking the coding interview u penn - sept 30 2010
1) The document provides an overview of the technical interview process at large tech companies and advice on how to prepare. It discusses the typical interview structure, what companies look for, and red flags.
2) It recommends getting hands-on coding experience through projects, open source contributions, or part-time work. The author's company CareerCup provides technical interview preparation resources.
3) Key tips for the interview include practicing common algorithms and data structures, thinking out loud, testing code thoroughly, and maintaining a positive attitude even if you make a mistake. Pattern matching prior problems and simplifying the problem are suggested approaches.
Clean Code, Resumen Capítulo 1.
Resumen del capítulo 1 del libro de Robert C. Martin:
Clean code: a handbook of agile software craftsmanship. Upper Saddle River, NJ: Prentice Hall
Para la clase Gestión de Calidad de Software. Universidad Pontificia Bolivariana, Medellín 2016
Why coding convention ?
Coding conventions provide guidelines for programming style, practices, and naming to make code more consistent, easier to understand, and maintainable. They set standards for indentation, brace style, naming conventions, and other aspects so that collaborators can work together effectively and consistently. While different styles can work, it is important for a team to agree on and stick to shared conventions.
Level Up Your Automated Tests
The document discusses ways to improve automated testing practices, such as by making tests easier to write, more readable, and more meaningful. It suggests using mocking frameworks to reduce test complexity, following standards and examples, and adopting a testing framework like Spock that addresses common issues. While progress has been made, there is still work to be done to encourage writing tests, make tests easy to write and understand, and ensure tests are meaningful and focused on the purposes of testing.
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
What's hot (20)
Documenting Code - Patterns and Anti-patterns - NLPW 2016
Documenting Code - Patterns and Anti-patterns - NLPW 2016
How to write maintainable code - Peter Hilton - Codemotion Amsterdam 2017
How to write maintainable code - Peter Hilton - Codemotion Amsterdam 2017
Cracking the coding interview u penn - sept 30 2010
Cracking the coding interview u penn - sept 30 2010
Viewers also liked
Coding standards
Coding standards are the standards required while programming to increase reliability,efficiency and maintenance of software.
Clean Code
The document discusses the principles of clean code as outlined in the book "Clean Code" by Robert C. Martin. It covers topics like meaningful names, comments, functions, objects and data structures, error handling, and unit tests. The goal of clean code is to produce readable, maintainable code through practices like breaking code into small, single-purpose functions and hiding implementation details in objects.
Clean Code - Design Patterns and Best Practices at Silicon Valley Code Camp
Why writing Clean Code makes us more efficient Over the lifetime of a product, maintaining the product is actually one - if not the most - expensive area(s) of the overall product costs.
Writing clean code can significantly lower these costs. However, writing clean code also makes you more efficient during the initial development time and results in more stable code.
You will be presented design patterns and best practices which will make you write better and more easily maintainable code, seeing code in a holistic way. You will learn how to apply them by using an existing implementation as the starting point of the presentation. Finally, patterns & practices benefits are explained. This presentation is based on C# and Visual Studio 2012.
However, the demonstrated patterns and practice can be applied to almost every other programming language too.
Clean Code I - Best Practices
All 3 Clean Code presentations provide great value by themselves, but taken together are designed to offer a holistic approach to successful software creation. This first session creates the foundation for the 2nd and 3rd Clean Code presentation on Dependency Injection, as it explains expected base knowledge. Why writing Clean Code makes us more efficient Over the lifetime of a product, maintaining the product is actually one - if not the most - expensive area(s) of the overall product costs.
Writing clean code can significantly lower these costs. However, writing clean code also makes you more efficient during the initial development time and results in more stable code. You will be presented design patterns and best practices which will make you write better and more easily maintainable code, seeing code in a holistic way.
You will learn how to apply them by using an existing implementation as the starting point of the presentation. Finally, patterns & practices benefits are explained. This presentation is based on C# and Visual Studio 2012. However, the demonstrated patterns and practice can be applied to every other programming language too.
Note: Moving forwards this presentation will be updated with the latest version of the slides for the last event I did the presentation instead of creating new separate slide decks here on SlideShare.
Presentation dates and locations:
2015-10-03 Silicon Valley Code Camp, San Jose, CA
2015-06-27 SoCal Code Camp - San Diego, CA
2014-11-14 SoCal Code Camp - Los Angeles, CA
2014-10-18 Desert Code Camp - Chandler, AZ
2014-10-11 Silicon Valley Code Camp, Los Altos Hills, CA
Coding standards and guidelines
The document discusses coding standards and guidelines for developers to follow. It recommends limiting lines of code to 20 lines per function, writing comments before code, using PascalCase for class and method names and camelCase for variables, and giving functions, classes and variables meaningful names. Developers should not use single character variable names or underscores for local variables, and should prefix boolean variables with "is". Namespace names should follow a standard pattern of company, product, top and bottom level modules. Formatting and readability of code is also important. Future sessions will cover additional coding standards, tools to improve practices, and packaging programs.
Clean code
My talk at OSOCO Dev Day and @madriagil about Robert C. Martin's book "Clean Code".
Dates:
28-04-2011
19-05-2011
What is Ubuntu - presentation
Ubuntu Linux is a free and open-source operating system based on Debian GNU/Linux with a wide range of pre-installed applications. It has a philosophy of being freely accessible to all and believes software should be free, modifiable, and shared. Ubuntu follows a six-month release cycle and has a large, helpful global community for sharing knowledge and solving problems.
Clean coding-practices
The document discusses clean coding practices for Java developers. It covers topics such as choosing meaningful names for variables, methods, and classes; writing code that is easy for others to understand; breaking methods down into single logical steps; and using fluent APIs to make code more readable. The presentation provides examples of clean code and ways to refactor code to follow best practices.
Viewers also liked (9)
Clean Code - Design Patterns and Best Practices at Silicon Valley Code Camp
Clean Code - Design Patterns and Best Practices at Silicon Valley Code Camp
Similar to Clean code and Coding Standards
Code Review
The document outlines Erik Ecoologic's process for reviewing code. It begins by stating that code reviews should not be too large and commits should have clear messages. It then details the steps Erik takes which include reading architecture, tasks, commits and code from specs. Erik ensures code meets quality standards through testing, readability, simplicity and following best practices. Comments are suggested objectively and learning is emphasized. The document promotes being kind and discussing code in-person. Resources on code reviews, the programmer's oath, clean code and agile principles are also provided.
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.
Coderetreat - Practice to Master Your Crafts
Coderetreat is a one day intense workshop for software developers for imporving their development skills by practicing. This is the material I presented at the beginning of coderetreat I facilitated on May 2014.
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
Kata Your Way to SW Craftsmanship
Becoming a Software Craftsman takes a lot of practice. Using Code Katas in Coding Dojos is an excellent way to get that practice in a low stress fun way. Discover how to do that.
Tips for Writing Better Code
Writing better code is important for readability, maintainability, simplicity, efficiency, and clarity. Tips for better code include commenting and documenting code according to standards, consistent indentation, avoiding obvious comments, grouping code logically, using consistent naming schemes, and limiting deep nesting. Other tips are limiting line length, well organizing files and folders, using revision control and commit messages, automating repetitive tasks, refactoring code periodically, allowing time for learning, and reading open source code.
Style & Design Principles 01 - Code Style & Structure
Chapter 01 of the lecture Style & Design Principles taught at SAE Institute Hamburg.
Introduction to naming conventions, type and member design, exception design and common .NET interfaces.
Pair Programming Styles
A basic introduction of the practice of pair programming along with some common styles and tried and tested techniques.
JOSA TechTalks - Compilers, Transpilers, and Why You Should Care
This document discusses compilers, transpilers, and why understanding them is important. It introduces compiler concepts like lexers, parsers, and code generation. It then demonstrates how to solve real problems by writing compiler transformations, like converting function expressions to arrow functions or lint rules to disallow certain syntax. Overall, it advocates learning the basics of compilers in order to build your own domain-specific languages, tools, and codemods to manipulate code like data.
Clean code presentation
Clan code is extremely essential to build scalable application which can be maintained quite easily and improved further
Slide was prepared with contribution to my colleague
and i thank them for the help!
Global Day of Coderetreat'14 - Istanbul Event
These are the slides we used during Istanbul/Turkey event of Global Day of Coderetreat on November 15th, 2014.
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.
Eurosport's Kodakademi #2
Second "code school lesson" for Eurosport's developers.
1. Refactoring : when? why? how?
2. Single Responsability
3. Practical case : clean architecture.
A Type-level Ruby Interpreter for Testing and Understanding
Type Profiler is a type analyzer for Ruby 3 that analyzes non-annotated Ruby code. It runs Ruby code at the type level to find potential errors and prototype type signatures. It forks execution for branches and reuses results when possible. While not perfect, it provides basic type checking capabilities for Ruby without requiring type annotations. The author acknowledges limitations and many areas for future work to improve Type Profiler.
Software Design
The document provides an agenda and introduction for a two-day software design training.
Day 1 covers introduction to software design principles, object oriented concepts and design, and evaluating software design. Day 2 covers software design patterns and clean code.
The introduction defines software design, contrasts it with architecture and coding, and outlines principles of software design such as SOLID and DRY. It also discusses software design considerations, modeling, and checkpoints. Later sections explain object oriented concepts, design principles including GRASP, and techniques for evaluating design quality.
TDD - Christchurch APN May 2012
Test Driven Development Intro and demonstration.
Delivered at Christchurch Agile Professionals Network on 31 May 2012
Coding conventions
This document discusses code standards and best practices for writing maintainable code. It emphasizes the importance of code organization, documentation, naming conventions, indentation, brace styles, commenting, consistency, and readability. Specific guidelines are provided for naming conventions, indentation, brace styles, and commenting. The document stresses choosing and adhering to coding standards to promote uniformity and minimize issues when collaborating on projects.
Clean Code
Même le code source mal écrit s’exécute! Du code source qui n’est pas propre peut grandement affecter l’efficacité d’une organisation de développement
logiciel. Chaque année, d’innombrables heures sont perdues par les équipes de développement à cause d’un code source mal écrit.
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.
Scaling your code review
Talk given during Coolblue Behind the Scenes on July 19th 2016, explaining what code review is, how to improve the quality of your reviews and what Coolblue learned while scaling this process up to 150 developers.
Similar to Clean code and Coding Standards (20)
Style & Design Principles 01 - Code Style & Structure
Style & Design Principles 01 - Code Style & Structure
JOSA TechTalks - Compilers, Transpilers, and Why You Should Care
JOSA TechTalks - Compilers, Transpilers, and Why You Should Care
A Type-level Ruby Interpreter for Testing and Understanding
A Type-level Ruby Interpreter for Testing and Understanding
Recently uploaded
RAT: Retrieval Augmented Thoughts Elicit Context-Aware Reasoning in Long-Hori...
RAT: Retrieval Augmented Thoughts Elicit Context-Aware Reasoning in Long-Horizon Generation
Iron and Steel Technology Roadmap - Towards more sustainable steelmaking.pdf
Iron and Steel Technology towards Sustainable Steelmaking
Understanding Inductive Bias in Machine Learning
This presentation explores the concept of inductive bias in machine learning. It explains how algorithms come with built-in assumptions and preferences that guide the learning process. You'll learn about the different types of inductive bias and how they can impact the performance and generalizability of machine learning models.
The presentation also covers the positive and negative aspects of inductive bias, along with strategies for mitigating potential drawbacks. We'll explore examples of how bias manifests in algorithms like neural networks and decision trees.
By understanding inductive bias, you can gain valuable insights into how machine learning models work and make informed decisions when building and deploying them.
[JPP-1] - (JEE 3.0) - Kinematics 1D - 14th May..pdf
Kinematics 11th jpp- 01. ( Solved ) unacademy namo kaul on 14th may...
Modelagem de um CSTR com reação endotermica.pdf
Modelagem em função de transferencia. CSTR não-linear.
bank management system in java and mysql report1.pdf
truth is high but higher still is truth full living
New techniques for characterising damage in rock slopes.pdf
rock mass characterization and New techniques for characterising damage in rock slopes
Recycled Concrete Aggregate in Construction Part III
Using recycled concrete aggregates (RCA) for pavements is crucial to achieving sustainability. Implementing RCA for new pavement can minimize carbon footprint, conserve natural resources, reduce harmful emissions, and lower life cycle costs. Compared to natural aggregate (NA), RCA pavement has fewer comprehensive studies and sustainability assessments.
Literature Review Basics and Understanding Reference Management.pptx
Three-day training on academic research focuses on analytical tools at United Technical College, supported by the University Grant Commission, Nepal. 24-26 May 2024
A SYSTEMATIC RISK ASSESSMENT APPROACH FOR SECURING THE SMART IRRIGATION SYSTEMS
The smart irrigation system represents an innovative approach to optimize water usage in agricultural and landscaping practices. The integration of cutting-edge technologies, including sensors, actuators, and data analysis, empowers this system to provide accurate monitoring and control of irrigation processes by leveraging real-time environmental conditions. The main objective of a smart irrigation system is to optimize water efficiency, minimize expenses, and foster the adoption of sustainable water management methods. This paper conducts a systematic risk assessment by exploring the key components/assets and their functionalities in the smart irrigation system. The crucial role of sensors in gathering data on soil moisture, weather patterns, and plant well-being is emphasized in this system. These sensors enable intelligent decision-making in irrigation scheduling and water distribution, leading to enhanced water efficiency and sustainable water management practices. Actuators enable automated control of irrigation devices, ensuring precise and targeted water delivery to plants. Additionally, the paper addresses the potential threat and vulnerabilities associated with smart irrigation systems. It discusses limitations of the system, such as power constraints and computational capabilities, and calculates the potential security risks. The paper suggests possible risk treatment methods for effective secure system operation. In conclusion, the paper emphasizes the significant benefits of implementing smart irrigation systems, including improved water conservation, increased crop yield, and reduced environmental impact. Additionally, based on the security analysis conducted, the paper recommends the implementation of countermeasures and security approaches to address vulnerabilities and ensure the integrity and reliability of the system. By incorporating these measures, smart irrigation technology can revolutionize water management practices in agriculture, promoting sustainability, resource efficiency, and safeguarding against potential security threats.
Embedded machine learning-based road conditions and driving behavior monitoring
Car accident rates have increased in recent years, resulting in losses in human lives, properties, and other financial costs. An embedded machine learning-based system is developed to address this critical issue. The system can monitor road conditions, detect driving patterns, and identify aggressive driving behaviors. The system is based on neural networks trained on a comprehensive dataset of driving events, driving styles, and road conditions. The system effectively detects potential risks and helps mitigate the frequency and impact of accidents. The primary goal is to ensure the safety of drivers and vehicles. Collecting data involved gathering information on three key road events: normal street and normal drive, speed bumps, circular yellow speed bumps, and three aggressive driving actions: sudden start, sudden stop, and sudden entry. The gathered data is processed and analyzed using a machine learning system designed for limited power and memory devices. The developed system resulted in 91.9% accuracy, 93.6% precision, and 92% recall. The achieved inference time on an Arduino Nano 33 BLE Sense with a 32-bit CPU running at 64 MHz is 34 ms and requires 2.6 kB peak RAM and 139.9 kB program flash memory, making it suitable for resource-constrained embedded systems.
Recently uploaded (20)
RAT: Retrieval Augmented Thoughts Elicit Context-Aware Reasoning in Long-Hori...
RAT: Retrieval Augmented Thoughts Elicit Context-Aware Reasoning in Long-Hori...
basic-wireline-operations-course-mahmoud-f-radwan.pdf
basic-wireline-operations-course-mahmoud-f-radwan.pdf
Iron and Steel Technology Roadmap - Towards more sustainable steelmaking.pdf
Iron and Steel Technology Roadmap - Towards more sustainable steelmaking.pdf
[JPP-1] - (JEE 3.0) - Kinematics 1D - 14th May..pdf
[JPP-1] - (JEE 3.0) - Kinematics 1D - 14th May..pdf
bank management system in java and mysql report1.pdf
bank management system in java and mysql report1.pdf
New techniques for characterising damage in rock slopes.pdf
New techniques for characterising damage in rock slopes.pdf
Recycled Concrete Aggregate in Construction Part III
Recycled Concrete Aggregate in Construction Part III
BPV-GUI-01-Guide-for-ASME-Review-Teams-(General)-10-10-2023.pdf
BPV-GUI-01-Guide-for-ASME-Review-Teams-(General)-10-10-2023.pdf
Literature Review Basics and Understanding Reference Management.pptx
Literature Review Basics and Understanding Reference Management.pptx
ACRP 4-09 Risk Assessment Method to Support Modification of Airfield Separat...
ACRP 4-09 Risk Assessment Method to Support Modification of Airfield Separat...
ML Based Model for NIDS MSc Updated Presentation.v2.pptx
ML Based Model for NIDS MSc Updated Presentation.v2.pptx
A SYSTEMATIC RISK ASSESSMENT APPROACH FOR SECURING THE SMART IRRIGATION SYSTEMS
A SYSTEMATIC RISK ASSESSMENT APPROACH FOR SECURING THE SMART IRRIGATION SYSTEMS
Embedded machine learning-based road conditions and driving behavior monitoring
Embedded machine learning-based road conditions and driving behavior monitoring
Clean code and Coding Standards
- 1. Clean Code and Coding Standards
- 5. Boy Scout Rule: “Always leave the campground cleaner than you found it.”
- 6. Meaningful Names (Open Discussion) • Avoid Disinformation • Make Meaningful Distinctions • Use Pronounceable Names • Use Searchable Names • Member Prefixes (Avoid encodings) • Hungarian Notation (Avoid encodings) • Avoid Mental Mapping • Class and Method Names • Pick One Word per Concept
- 7. Functions (Open Discussion) • Small functions • Do One Thing • One Level of Abstraction per Function • Reading Code from Top to Bottom • Use Descriptive Names • Function Arguments • Don’t Repeat Yourself (DRY) • Structured Programming • Indentation
- 8. Comments (Open Discussion) • Comments Do Not Make Up for Bad Code // don’t comment bad code, rewrite it! • Explain Yourself in Code • Legal Comments • Informative Comments • Explanation of Intent • Clarification • Warning of Consequences • TODO Comments • Bad comments examples (/* The ****** variable */)
- 9. Formatting (Open Discussion) • Team Rules: every programmer has his own favorite formatting rules but if he works in a team then the team rules. • Single template and color scheme for whole team.
- 10. Error Handling (Open Discussion) • Prefer Exceptions to Returning Error Codes • Extract Try/Catch Blocks • Don’t Return Null
- 11. Coding Standards • Java: http://www.oracle.com/technetwork/java/codeconvtoc- 136057.html • PHP http://www.php-fig.org/psr/psr-2/ • C# https://msdn.microsoft.com/en-us/library/ff926074.aspx • Android https://source.android.com/source/code-style.html • Objective C https://github.com/raywenderlich/objective-c-style-guide • Swift https://github.com/raywenderlich/swift-style-guide • AngularJS https://google.github.io/styleguide/angularjs-google- style.html
- 12. Questions?