Clean code and Coding Standards

Mar 8, 2016Download as PPTX, PDF1 like1,037 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.

Boy Scout Rule:
��Always leave the campground cleaner than you found it.��

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

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

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 */)

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.

Error Handling (Open Discussion)
? Prefer Exceptions to Returning Error Codes
? Extract Try/Catch Blocks
? Don��t Return Null

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

Rule 1: Follow a consistent coding standard Rule 2: Name things properly, long variable and function names are allowed Rule 3: Be expressive, write code as you speak and be optimally verbose Rule 4: Max indent per method should be 2, in case of exceptions 3 Rule 5: Avoid creating god object and long methods Rule 6: Keep the method in one place, inject the class and call it, DRY Rule 7: Avoid in-line comments (comment with code), put comments in the method doc

Cloudera - The Modern Platform for AnalyticsCloudera, Inc.

Polyglot Persistence Dr-Dipali Meher

- Polyglot persistence involves using multiple data storage technologies to handle different data storage needs within a single application. This allows using the right technology for the job rather than trying to solve all problems with a single database. - For example, a key-value store may be better for transient session or shopping cart data before an order is placed, while relational databases are better for structured transactional data after an order is placed. - Using services that abstract the direct usage of different data stores allows sharing of data between applications in an enterprise. This improves reuse of data across systems.

Code refactoringLalit Kale

Latex slidesDr. Vijay Ukani

This document provides an introduction to LaTeX, covering topics such as motivation, basics, controlling appearance, adding structure, and BibTeX references. It explains what LaTeX is, why it is used, its advantages over word processors, and some limitations. It also covers LaTeX commands, document structure, running LaTeX, formatting text, adding lists, sections, tables, figures, and equations. The document is presented as a slideshow introduction to LaTeX.

Bridging Between CAD & GIS: 8 Ways to Automate Data IntegrationSafe Software

Converting between CAD and GIS is a common requirement for projects involving infrastructure, buildings, city plans, and more. Unfortunately, the workflow presents many challenges, like translating geometry, attributes, annotations, symbology, geolocation, and other elements. So how do you allow data to flow freely between these disparate data types, without losing the precision offered by CAD and the spatial context offered by GIS? This webinar will explore the power of automated data integration workflows for CAD and GIS. First, we��ll discuss challenges and scenarios for CAD-to-GIS translations, and demo how to use FME to power a digital plan submission portal that validates CAD data and integrates it into the central GIS repository. Next, we��ll discuss challenges and scenarios for GIS-to-CAD conversions, and demo how to build an automated FME workflow for requesting CAD data from GIS. At the end of the webinar, you'll know how to achieve harmony between CAD & GIS by automating its integration.

Relational to Big GraphNeo4j

Relational databases power most applications, but new use-cases have requirements that they are not well suited for. That's why new approaches like graph databases are used to handle join-heavy, highly-connected and realtime aspects of your applications. This talk compares relational and graph databases, show similarities and important differences. We do a hands-on, deep-dive into ease of data modeling and structural evolution, massive data import and high performance querying with Neo4j, the most popular graph database. I demonstrate a useful tool which makes data import from existing relational databases with a non-denormalized ER-model a "one click"-experience. Which leaves biggest challenge for people coming from a relational background is to adapt some of their existing database experience to new ways of thinking.

Low Code Neuro-Symbolic Agents.pdfDenis Gagn��

This presentation aims to provide a comprehensive understanding of a form of neuro-symbolic AI, prompt engineering, and the role of process and decision orchestration in achieving optimal outcomes. By exploring the building blocks of prompt orchestration and showcasing examples, we seek to inspire the audience to harness the power of prompt engineering and contribute to the development of responsible and effective AI systems.

Introduction to Knowledge Graphs: Data Summit 2020Enterprise Knowledge

This workshop presentation from Enterprise Knowledge team members Joe Hilger, Founder and COO, and Sara Nash, Technical Analyst, was delivered on June 8, 2020 as part of the Data Summit 2020 virtual conference. The 3-hour workshop provided an interdisciplinary group of participants with a definition of what a knowledge graph is, how it is implemented, and how it can be used to increase the value of your organization��s datas. This slide deck gives an overview of the KM concepts that are necessary for the implementation of knowledge graphs as a foundation for Enterprise Artificial Intelligence (AI). Hilger and Nash also outlined four use cases for knowledge graphs, including recommendation engines and natural language query on structured data.

Successful Content Management Through Taxonomy And Metadata Designsarakirsten

The document discusses taxonomy and metadata design for content management. It defines taxonomy and metadata, and explains how taxonomies can provide structure to unstructured information and enable findability. It discusses different types of taxonomies including traditional vs. business taxonomies. The document outlines best practices for taxonomy design such as defining use cases, audience, and governance as well as controlling depth and breadth. It proposes a workshop concept to develop taxonomies through identifying topics, verbs, nouns, and creating a starter taxonomy.

Clean Code I - Best PracticesTheo Jungeblut

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 �ݺ�ߣShare. 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

Sql joins inner join self join outer joinsDeepthi Rachumallu

This document discusses different types of SQL joins, including inner joins, left joins, right joins, full joins, and self joins. It provides examples of the syntax for each type of join, along with sample queries and resulting tables to illustrate how each join works. Inner joins return rows where there is a match in both tables. Left and right joins return all rows from the left or right table respectively, along with matched or null rows from the other table. Full joins return all rows and fill in nulls for missing matches. Self joins allow a table to join with itself.

Introduction to Knowledge Graphs and Semantic AISemantic Web Company

- Learn to understand what knowledge graphs are for - Understand the structure of knowledge graphs (and how it relates to taxonomies and ontologies) - Understand how knowledge graphs can be created using manual, semi-automatic, and fully automatic methods. - Understand knowledge graphs as a basis for data integration in companies - Understand knowledge graphs as tools for data governance and data quality management - Implement and further develop knowledge graphs in companies - Query and visualize knowledge graphs (including SPARQL and SHACL crash course) - Use knowledge graphs and machine learning to enable information retrieval, text mining and document classification with the highest precision - Develop digital assistants and question and answer systems based on semantic knowledge graphs - Understand how knowledge graphs can be combined with text mining and machine learning techniques - Apply knowledge graphs in practice: Case studies and demo applications

Chapter 6.pptxRanjanaShevkar

Neural Machine Translation (D3L4 Deep Learning for Speech and Language UPC 2017)Universitat Polit��cnica de Catalunya

https://telecombcn-dl.github.io/2017-dlsl/ Winter School on Deep Learning for Speech and Language. UPC BarcelonaTech ETSETB TelecomBCN. The aim of this course is to train students in methods of deep learning for speech and language. Recurrent Neural Networks (RNN) will be presented and analyzed in detail to understand the potential of these state of the art tools for time series processing. Engineering tips and scalability issues will be addressed to solve tasks such as machine translation, speech recognition, speech synthesis or question answering. Hands-on sessions will provide development skills so that attendees can become competent in contemporary data analytics tools.

Introduction to Overleaf WorkshopOlga Scrivner

How to Quickly Prototype a Scalable Graph Architecture: A Framework for Rapid...Enterprise Knowledge

Sara Nash and Thomas Mitrevski discuss the toolkit to scope and execute knowledge graph prototypes successfully in a matter of weeks. The framework discussed includes the development of a foundational semantic model (e.g. taxonomies/ontologies) and resources and skill sets needed for successful initiatives so that knowledge graph products can scale, as well as the data architecture and tooling required (e.g., orchestration and storage) for enterprise-scale implementation. This presentation was originally delivered at KGC 2022 in Boston, MA.

mysql-Tutorial with Query presentation.pptaptechaligarh

Ms sql-serverMd.Mojibul Hoque

Introduction to NoSQLDr-Dipali Meher

The document provides an introduction to NoSQL databases. It discusses that NoSQL databases provide a mechanism for storage and retrieval of data without using tabular relations like relational databases. NoSQL databases are used in real-time web applications and for big data. They also support SQL-like query languages. The document outlines different data modeling approaches, distribution models, consistency models and MapReduce in NoSQL databases.

Training Week: Introduction to Neo4j Aura FreeNeo4j

This document outlines an agenda for a training on Neo4j Aura. It includes an introduction to graphs and Neo4j, an overview of Neo4j Aura, and hands-on exercises to create an Aura instance, import sample data, interact with the data using Cypher queries and Bloom, connect desktop tools and applications, and review additional resources. The training covers key concepts around graph databases, Neo4j Aura's features and tiers, ways to connect to an Aura database from various clients, and how to import and explore sample data in an Aura instance.

Graph-Based Customer Journey Analytics with Neo4jNeo4j

This document discusses graph-based customer journey analytics using Neo4j. It describes how traditional customer journey maps only focus on individual interactions and miss the big picture. Graphs can capture the complexity of a customer's full journey across channels over time. The document outlines how Neo4j allows building an active customer journey model that is visualizable, flexible, agile and actionable to provide recommendations and notifications. It concludes by describing how to get started using Neo4j to build a graph-based customer journey analytics solution.

MySQLGouthaman V

Database NormalizationDan D'Urso

This document discusses database normalization and provides an example of normalizing a database table through the three normal forms: 1) The original table tracks equipment placed in chemical plants and violates first normal form by having a cell with multiple values. 2) The table is split into multiple tables which satisfies first normal form but still violates second normal form by having a partial key dependency. 3) Further splitting removes the partial key dependency and satisfies second normal form, but a transitive dependency remains in violation of third normal form. 4) The final normalization fully removes dependencies and satisfies all three normal forms.

Talend Open Studio Fundamentals #1: Workspaces, Jobs, Metadata and Trips & Tr...Gabriele Baldassarre

data manipulation languageJananiSelvaraj10

Database Management Software or DBM software is used for storing, manipulating, and managing data, such as format, names of fields, and record and file structures in a database environment. Users can construct their own databases using a DBMS to satisfy their business requirements. Database design also supports the creation, design, implementation, and maintenance of an organization-wide data management system. To interact with a database, a DBMS package generally uses SQL queries. It receives a command from a database administrator (DBA) and prompts the system to perform the necessary action. These instructions can be about loading, retrieving, or modifying existing data in the system. We have explained about DMl Commands such as INSERT, DELETE, SELECT, commands

Schema migrations in no sqlDr-Dipali Meher

The document discusses schema migrations in NoSQL databases. It begins by defining database schemas and how they differ between SQL and NoSQL databases. In NoSQL databases, schemas are often dynamic or non-existent. The document then examines various techniques for handling schema changes in NoSQL databases including incremental migrations, handling multiple schemas during a transition period, and changing aggregate structures. It provides examples of schema migrations for each technique using MongoDB and graph databases.

Functional programming with Java 8Talha Ocak??

Functional programming in Java 8 allows for: 1) The use of lambda expressions and streams for a more declarative programming style without iteration. 2) Functional interfaces like Function, Predicate, and Consumer along with lambda expressions enable function composition and chaining. 3) Features like immutable collections help reduce mutability and side effects, important aspects of functional programming.

Clean Code and Common Engineering PracticesRuth Sperer

Coding standardsMimoh Ojha

More Related Content

What's hot (20)

Introduction to Knowledge Graphs: Data Summit 2020Enterprise Knowledge

Successful Content Management Through Taxonomy And Metadata Designsarakirsten

Clean Code I - Best PracticesTheo Jungeblut

Sql joins inner join self join outer joinsDeepthi Rachumallu

Introduction to Knowledge Graphs and Semantic AISemantic Web Company

Chapter 6.pptxRanjanaShevkar

Neural Machine Translation (D3L4 Deep Learning for Speech and Language UPC 2017)Universitat Polit��cnica de Catalunya

Introduction to Overleaf WorkshopOlga Scrivner

How to Quickly Prototype a Scalable Graph Architecture: A Framework for Rapid...Enterprise Knowledge

mysql-Tutorial with Query presentation.pptaptechaligarh

Ms sql-serverMd.Mojibul Hoque

Introduction to NoSQLDr-Dipali Meher

Training Week: Introduction to Neo4j Aura FreeNeo4j

Graph-Based Customer Journey Analytics with Neo4jNeo4j

MySQLGouthaman V

Database NormalizationDan D'Urso

Talend Open Studio Fundamentals #1: Workspaces, Jobs, Metadata and Trips & Tr...Gabriele Baldassarre

data manipulation languageJananiSelvaraj10

Schema migrations in no sqlDr-Dipali Meher

Functional programming with Java 8Talha Ocak??

Introduction to Knowledge Graphs: Data Summit 2020Enterprise Knowledge

Successful Content Management Through Taxonomy And Metadata Designsarakirsten

Clean Code I - Best PracticesTheo Jungeblut

Sql joins inner join self join outer joinsDeepthi Rachumallu

Introduction to Knowledge Graphs and Semantic AISemantic Web Company

Chapter 6.pptxRanjanaShevkar

Neural Machine Translation (D3L4 Deep Learning for Speech and Language UPC 2017)Universitat Polit��cnica de Catalunya

Introduction to Overleaf WorkshopOlga Scrivner

How to Quickly Prototype a Scalable Graph Architecture: A Framework for Rapid...Enterprise Knowledge

mysql-Tutorial with Query presentation.pptaptechaligarh

Ms sql-serverMd.Mojibul Hoque

Introduction to NoSQLDr-Dipali Meher

Training Week: Introduction to Neo4j Aura FreeNeo4j

Graph-Based Customer Journey Analytics with Neo4jNeo4j

MySQLGouthaman V

Database NormalizationDan D'Urso

Talend Open Studio Fundamentals #1: Workspaces, Jobs, Metadata and Trips & Tr...Gabriele Baldassarre

data manipulation languageJananiSelvaraj10

Schema migrations in no sqlDr-Dipali Meher

Functional programming with Java 8Talha Ocak??

Viewers also liked (10)

Clean Code and Common Engineering PracticesRuth Sperer

Coding standardsMimoh Ojha

Clean CodeHendrik Ebel

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 CampTheo Jungeblut

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 summaryJan de Vries

Coding standards and guidelinesbrijraj_singh

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 codeArturo Herrero

What is Ubuntu - presentationAhmed Mamdouh

�o覵ĳ�ʽ�a Clean Code �ĵ÷��Win Yu

Clean coding-practicesJohn Ferguson Smart Limited

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.

Clean Code and Common Engineering PracticesRuth Sperer

Coding standardsMimoh Ojha

Clean CodeHendrik Ebel

Clean Code - Design Patterns and Best Practices at Silicon Valley Code CampTheo Jungeblut

Clean Code summaryJan de Vries

Coding standards and guidelinesbrijraj_singh

Clean codeArturo Herrero

What is Ubuntu - presentationAhmed Mamdouh

�o覵ĳ�ʽ�a Clean Code �ĵ÷��Win Yu

Clean coding-practicesJohn Ferguson Smart Limited

Similar to Clean code and Coding Standards (20)

Code ReviewErik Ecoologic

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 professionalNh?t Nguy?n Kh?c

Coderetreat - Practice to Master Your CraftsLemi Orhan Ergin

Make a better with clean codeKeattiwut Kosittaruk

Kata Your Way to SW CraftsmanshipCamille Bell

Tips for Writing Better CodeJamshid Hashimi

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 & StructureNick Pruehs

Pair Programming StylesAttila Bert��k

JOSA TechTalks - Compilers, Transpilers, and Why You Should CareJordan Open Source Association

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 presentationBhavin Gandhi

Global Day of Coderetreat'14 - Istanbul EventLemi Orhan Ergin

Being Good DeveloperSally Ahmed

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 #2Benjamin Baumann

A Type-level Ruby Interpreter for Testing and Understandingmametter

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 DesignAhmed Misbah

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 2012Alan Christensen

Code Review Matters and MannersTrisha Gee

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.

Coding conventionssystemcrashed

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 CodeAbdelhakim Bachar

Clean codeSimon S?nnby

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.

Code ReviewErik Ecoologic

Clean code coding like a professionalNh?t Nguy?n Kh?c

Coderetreat - Practice to Master Your CraftsLemi Orhan Ergin

Make a better with clean codeKeattiwut Kosittaruk

Kata Your Way to SW CraftsmanshipCamille Bell

Tips for Writing Better CodeJamshid Hashimi

Style & Design Principles 01 - Code Style & StructureNick Pruehs

Pair Programming StylesAttila Bert��k

JOSA TechTalks - Compilers, Transpilers, and Why You Should CareJordan Open Source Association

Clean code presentationBhavin Gandhi

Global Day of Coderetreat'14 - Istanbul EventLemi Orhan Ergin

Being Good DeveloperSally Ahmed

Eurosport's Kodakademi #2Benjamin Baumann

A Type-level Ruby Interpreter for Testing and Understandingmametter

Software DesignAhmed Misbah

TDD - Christchurch APN May 2012Alan Christensen

Code Review Matters and MannersTrisha Gee

Coding conventionssystemcrashed

Clean CodeAbdelhakim Bachar

Clean codeSimon S?nnby

Recently uploaded (20)

???????? ???? ?????? ???????? ( ?????)kkkjjj kkkkk .pptxzeidali3

GRAPHS AND DISCONTINUITIES POWERPOINT.pptxChrisPuyoc1

02.BigDataAnalytics curso de Legsi (1).pdfruioliveira1921

Virtual Power plants-Cleantech-RevolutionAshoka Saket

PLANT CELL REACTORS presenation PTC amityUrjaMoon

Airport Components Part1 ppt.pptx-Site layout,RUNWAY,TAXIWAY,TAXILANEPriyanka Dange

Cloudera Partner Network Enablement Full.pdfNguy?n H?i

Chapter1-Introduction ��ɦҦ��æئæɦ�?? ?�ͦͦϦɦ�?ssuserb91a20

Why the Engineering Model is Key to Successful ProjectsMaadhu Creatives-Model Making Company

Lecture 16 - 17 - NonTraditional Machining Presentation.pptINSTITUTE OF ENGINEERING /BKC

Telehealth technology �C A new horizon in health careDr INBAMALAR T M

UHV UNIT-5 IMPLICATIONS OF THE ABOVE HOLISTIC UNDERSTANDING OF HARMONY ON ...ariomthermal2031

Disruption channel in business model innovation topicanandraj930873

Airport Components Part2 ppt.pptx-Apron,Hangers,Terminal buildingPriyanka Dange

Analysis of Daylighting in Interior Spaces using the Daylight Factor - A Manu...Ignacio J. J. Palma Carazo

UHV UNIT-3 HARMONY IN THE FAMILY AND SOCIETY.pptxariomthermal2031

DBMS Nested & Sub Queries Set operationsSreedhar Chowdam

Scalling Rails: The Journey to 200M NotificationsGustavo Araujo

applicationof differential equation.pptxPPSTUDIES

CCNA_Product_OverviewCCNA_Productsa.pptxUdayakumarAllimuthu

???????? ???? ?????? ???????? ( ?????)kkkjjj kkkkk .pptxzeidali3

GRAPHS AND DISCONTINUITIES POWERPOINT.pptxChrisPuyoc1

02.BigDataAnalytics curso de Legsi (1).pdfruioliveira1921

Virtual Power plants-Cleantech-RevolutionAshoka Saket

PLANT CELL REACTORS presenation PTC amityUrjaMoon

Airport Components Part1 ppt.pptx-Site layout,RUNWAY,TAXIWAY,TAXILANEPriyanka Dange

Cloudera Partner Network Enablement Full.pdfNguy?n H?i

Chapter1-Introduction ��ɦҦ��æئæɦ�?? ?�ͦͦϦɦ�?ssuserb91a20

Why the Engineering Model is Key to Successful ProjectsMaadhu Creatives-Model Making Company

Lecture 16 - 17 - NonTraditional Machining Presentation.pptINSTITUTE OF ENGINEERING /BKC

Telehealth technology �C A new horizon in health careDr INBAMALAR T M

UHV UNIT-5 IMPLICATIONS OF THE ABOVE HOLISTIC UNDERSTANDING OF HARMONY ON ...ariomthermal2031

Disruption channel in business model innovation topicanandraj930873

Airport Components Part2 ppt.pptx-Apron,Hangers,Terminal buildingPriyanka Dange

Analysis of Daylighting in Interior Spaces using the Daylight Factor - A Manu...Ignacio J. J. Palma Carazo

UHV UNIT-3 HARMONY IN THE FAMILY AND SOCIETY.pptxariomthermal2031

DBMS Nested & Sub Queries Set operationsSreedhar Chowdam

Scalling Rails: The Journey to 200M NotificationsGustavo Araujo

applicationof differential equation.pptxPPSTUDIES

CCNA_Product_OverviewCCNA_Productsa.pptxUdayakumarAllimuthu

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?

13. Thank You! Mahesh Salaria

�ݺ�ߣ

Clean code and Coding Standards

Recommended

More Related Content

What's hot (20)

Viewers also liked (10)

Similar to Clean code and Coding Standards (20)

Recently uploaded (20)

Clean code and Coding Standards