Clean code theory in English

Clean code theory in English

Table of contents

Clean Code Theory

What do the colors mean ?

When do i change from one color to another ?

What does red, orange, yellow, green and blue mean ?

How can i motivate other developers ?

How could we improve the quality of this article ?

Source code convention tools

Literature, good books and references

How can i subscribe/feed this blog ?

Want to stay up to date ?

How can i rate this blog ?

Where do i find more clean code knowledge and gadgets?

Clean Code Theory

Hi there! Inspired by the geman website www.clean-code-developer.de i have lauched the treslines.com initiative with the aim to make it also popular to the english speakers. In this blog i wanna make you familiar with the basic colors of the clean code initiative and its meaning.

What do the colors mean ?

Well, In the initiative there are 7 rotational degrees. It starts from black, thru red, orange, yellow, green, blue till white. Black means only that you are interested in learn more about it and are preparing yourself to get started. Personally, i do not thing that we nescessarily need this degree. It says only that you are interested in it. www.treslines.com offers gadgets to support the iniciative. There you’ll never find the colors black and white. The white degree means that the developer are working with a huge openminded horizont. Instead of wearing the white degree, the developer should turn back to the first degree and start it from the beginning again. Thats the reason we say ratational degrees.

When do i change from one color to another ?

Well, thats up to you. I recommend a period of 1-2 month each degree.

What does red, orange, yellow, green and blue mean ?

These are interesting degrees. In it we will find always design principles to apply and best practises to use. Check www.treslines.com for gadgets and know how about clean code as well agile development.

 

Principles

1. Don't Repeat Yourself (DRY)

2. Keep It Simple, Stupid (KISS)

3. Favor Composition over Inheritance (FCoI)

4. Beware of Optimisations (BoO)

Practises

1. Scouts rules

2. Root Cause Analysis

3. Version Control

4. Simple Refactoring

5. Daily Reflection of your Work

 

Principles

1. Single Level of Abstraction (SLA)

2. Single Responsability Principle (SRP)

3. Separation of Concerns (SoC)

4. Source Code Conventions

Practises

1. Issue Tracking

2. Auto Integration Tests

3. Read, read, read

4. Reviews

  

Principles

1. Interface Segregation Principle (ISP)

2. Dependency Invertion Principle (DIP)

3. Liskov Substitution Principle (LSP)

4. Principle of Least Astonishment (PoLA)

5. Information Hiding Principle (IHP)

Practises

1. Auto Unit Tests

2. Mockups

3. Code Coverage Analyse

4. Participation in professional events

5. Complex Refactoring

Principles

1. Open Close Principle (OCP)

2. Tell don't ask

3. Law of Demeter (LoD)

Practises

1. Continuous Integration I

2. Static Code Analysis

3. Inversion of Control Container

4. Expirience  sharing

5. Measure of Errors

Principles

1. Design & Implementation do not overlap (no inconsistency)

2. Implementation reflects design

3. You Ain't Gonna Need It (YAGNI)

Practises

1. Continuous Integration II

2. Iterative development

3. Component orientation (package structure)

4. Test First

How can i motivate other developers ?

Well i do that by talking about, i wear my treslines.com t-shirt, i wear my bracelets with the CCD (Clean Code Developer Initials and colors) and i use my brand new treslines bag. It feels fantastic and even on the train people start talking to me asking about it. It is also a great idea to motivate agile teams and to share your expirience. You may want a great gift to show your appreciation to your team. Surprise them with a gadget from www.treslines.com. I love it.

   

Other interesting blogs

·         How can i indicate the quality of my clean code to other developers?

·         How can i avoid violation of the DRY principle? (Don't Repeat Yourself)

·         How to write good, reusable comments without repeating yourself? (DRY)

·         How to wirte less comments without loosing context in your app?

·         Why do you need source conventions in your company?

·         How to write valueable documentation in your company?

·         What are the contraindications for agile projects? (checklist)

😱👇 PROMOTIONAL DISCOUNT: BOOKS AND IPODS PRO 😱👇

Be sure to read, it will change your life!

Show your work by Austin Kleon: https://amzn.to/34NVmwx

This book is a must read - it will put you in another level! (Expert)

Agile Software Development, Principles, Patterns, and Practices: https://amzn.to/30WQSm2

Write cleaner code and stand out!

Clean Code - A Handbook of Agile Software Craftsmanship: https://amzn.to/33RvaSv

This book is very practical, straightforward and to the point! Worth every penny!

Kotlin for Android App Development (Developer's Library): https://amzn.to/33VZ6gp

Needless to say, these are top right?

Apple AirPods Pro: https://amzn.to/2GOICxy

😱👆 PROMOTIONAL DISCOUNT: BOOKS AND IPODS PRO 😱👆

What are the contraindications for agile projects?

Table of contents

What are the contraindications for agile projects? (checklist)

When are agile methods suitable ?

How could we improve the quality of this article ?

Source code convention tools

Literature, good books and references

How can i subscribe/feed this blog ?

Want to stay up to date ?

How can i rate this blog ?

Where do i find more clean code knowledge and gadgets?

What are the contraindications for agile projects? (checklist)

When are agile methods suitable ?

Agiler Background: The agile approach is not always the best solution. There are work environment or circumstances that militate against the agile approach. Below are the contra-indicators to observe and evaluate:. Agile Contraindicators: These are the criteria, which does not speak for the agile approach. In this case, other approaches shall be favored.                 Contraindications Customer o  The project goal is not SMART. The goal is not clear. (specific, measurable, appropriate, relevant, terminated) o  process is defined and regulated. (e.g. by Authority or Law) o  Nice-To-Have-projects. If the pressure required is missing or it has no great significance for the organization. (No pressure = no result value) o  Customer’s decision takes a long time. When agile process, the feedback is an important element. The absence of this element, makes the project to fail. o  Lengthy change request process. These are formalized change process. The project stays still. o  No user or customer contact. Projects without user or costumer contact are difficult to perform agile. o  customer does not control the outputs. The customer must take care of the project. At least 50% of the time available shall be invested, otherwise the above-mentioned problems will arrive. o  creation of life critical software. If the meaning of provability is higher than the agile approach. o  fear of responsibility. If errors are not seen as an opportunity to learn, but interpreted as misconduct charge. o  Client does not support the agile approach. To customer needs to come and play its role in the feedback activity. o  No work on site possible. For agile methods is the close cooperation with customers and users very important. o  fixed price projects - in such cases, consider whether or not feature driven development would be appropriate. It comes from fixed-price combinations. o  Client is an authority - If the Customer is an authority, most of the decision paths takes to long, fixed price, a given process, i.e. a collection of some contraindications. Contraindications Developers o  No experience with agile projects, and no coach available. o  unwillingness or inability to learn. Agile software development is a learning process. o  culture of command and obedience - in a strictly hierarchical culture that grants the instructions almost like commands, each devbeloper is controlled so that any error is found for a guilty person, are not suitable for the application of agile methods. o  If developers do not want user contact - then it is hardly possible to apply agile methods. o  High developer fluctuation which is not good for the team o  Developer does not accept to work on site if needed or possible. o  No management commitment to an agile method - without it is not possible. Contraindication Technology o  Long build time Agile Tip! Book tip: Agile software development, values, concepts, methods of Wolf-Gideon Bleek - Henning Wolf-Morgan Kaufmann Publishers, - ISBN: 978-3-89864-473-0

😱👇 PROMOTIONAL DISCOUNT: BOOKS AND IPODS PRO 😱👇

Be sure to read, it will change your life!

Show your work by Austin Kleon: https://amzn.to/34NVmwx

This book is a must read - it will put you in another level! (Expert)

Agile Software Development, Principles, Patterns, and Practices: https://amzn.to/30WQSm2

Write cleaner code and stand out!

Clean Code - A Handbook of Agile Software Craftsmanship: https://amzn.to/33RvaSv

This book is very practical, straightforward and to the point! Worth every penny!

Kotlin for Android App Development (Developer's Library): https://amzn.to/33VZ6gp

Needless to say, these are top right?

Apple AirPods Pro: https://amzn.to/2GOICxy

😱👆 PROMOTIONAL DISCOUNT: BOOKS AND IPODS PRO 😱👆

Why do you need a valuable system documentation?

Why do you need a valuable system documentation ?

Table of contents

How to write valuable system documentation with agile principles ?

How can i figure out if my documentation is valuable ?

How does the structure of a good documentation looks like?

Why do you need the system-documentation in this sequence?

How can i optimize my system documentation?

Don’t i need process documentation?

How can i avoid redundant documentation?

How could we improve the quality of this article ?

Source code convention tools

Literature, good books and references

How can i subscribe/feed this blog ?

Want to stay up to date ?

How can i rate this blog ?

Where do i find more clean code knowledge and gadgets?

How to write valuable system documentation with agile principles ?

Hi there! In this blog i wanna show you, why agile concepts need a valueable documentation and why to many developers missunderstand the agile manifest. You’ll see and understand how to structure the documentation, to figure out a good, valuable documentation saving a lot of time. This blog will give you some tequiniques and methods and best practices making your company more profittable as you always has dreamed of it. Share this expirience with other developers.

How can i figure out if my documentation is valuable ?

Well, to understand that, we must find out what is essencial needed and why! To do so before writting any documentation ask yourself those valuable questions:

Document purpose : Why do i really need this documentation ?

Documentation sort : How does the minimally systematic looks like ?

If you can’t aswer those questions, do not spend a lot of time writing something that nobody will read. We only write documentation if it brings an additional benefit.

Important: If it is possible to solve or clear something over conversation, favor this way over writing documentation.

How does the structure of a good documentation looks like?

Well first of all we must know, what kind of documentation a software really needs and how to differentiate between system-documentation and stakeholder-documentation.

A system-documentation looks normally like this acc. to the best practises :

·         Architecture overview (maintenance, build deployement, development)

·         Interface handbook (for external partners)

·         Operating handbook (for operation, installation etc.)

·         Admin handbook (for context administration)

·         Support handbook (after delivery and only if needed)

This was a template. To be sure you have covered the needs of your stakeholders show it to them and ask for feedbaks. It is always better to make pro-active a proposal because otherwise the stakeholders could say: i need it all or everything is nescessary.

Why do you need the system-documentation in this sequence?

Well thats a good and very important question, because here you get the reasons why it tis essencial to have it.

We can expect that the maintenance and support/service phase is avarage 3 times bigger than the construction phase. In agile contexts even much bigger because of the short delivery cycles. The system-documentation you need exactly for this phase. (For the life cycle after delivery). For this reason the system-documentation must document mainly all information you need to maintain and support the system without asking developers or getting know-how from experts, that may no longer work in the company.

Construction vs Maintenance (3-5 times bigger)

|__________|__________|__________|__________|__________|__________|

How can i optimize my system documentation?

Well the principle here is not what ist possible, but what is really nescessary. Project-documentation is not a system-documentation. Favor the direct conversation with the stakeholders and ask them what they really need and why. The system-documentation contains in most of the cases all information needed.

The only reasons to write project documentation are :

·         Big projects : If the direct project communication is not possible.

·         High risk : to control risks. Usually medical projects and projects for the state.

·         Law requirements : the law requires it.

Don’t i need process documentation?

Good question. Sure! Process documentation is an internal and structural documentation. The most companies has it already, since they are ISO-Certified. This kind of documentation defines rules, process, concepts, models, project plan, meetings etc. If your company does not have an established process documentation you should do ti now ! Don’t think you can live without it. This is only true if your company has 3-5 employees.

How can i avoid redundant documentation?

Example : You do not have to write additional documentation if the information is normally only available for developers. Cookbooks, Source code, JavaDoc etc. describe and help developers enough. Do not spend time, documenting those things. Developers will do it automatically, if they need. Instead you should insist on a cookbook by developers. (developers should do that at a minimum to ensure know-how-transfer)

😱👇 PROMOTIONAL DISCOUNT: BOOKS AND IPODS PRO 😱👇

Be sure to read, it will change your life!

Show your work by Austin Kleon: https://amzn.to/34NVmwx

This book is a must read - it will put you in another level! (Expert)

Agile Software Development, Principles, Patterns, and Practices: https://amzn.to/30WQSm2

Write cleaner code and stand out!

Clean Code - A Handbook of Agile Software Craftsmanship: https://amzn.to/33RvaSv

This book is very practical, straightforward and to the point! Worth every penny!

Kotlin for Android App Development (Developer's Library): https://amzn.to/33VZ6gp

Needless to say, these are top right?

Apple AirPods Pro: https://amzn.to/2GOICxy

😱👆 PROMOTIONAL DISCOUNT: BOOKS AND IPODS PRO 😱👆

Don’t Repeat Yourself (DRY-Principle) ?

Table of contents

Why do you need source code conventions in your company?

An other common violation of the DRY principle is this one here :

Do you want to stay up to date?

Source code convention tools

Literature, good books and references

How can i subscribe/feed this blog ?

How can i rate this blog ?

Where do i find more clean code knowledge and gadgets?

How to avoid the violation of the DRY-principle?

In this blog i'm gonna show you how to avoid violation of the DRY principle. The most important thing: i will tell you WHY you should not. I'm gonna give you some arguments, so that you are able to explain and motivate anybody at anytime.

What i hate, is the violation of the DRY principle by copy-pate or auto-comments. It seams to be a world wide "disease", because we all know it, but still continually violate this principle almost all the time. Let's figure out what i mean by doing a very trivial example:

Bad example 1 - DRY violation by repeating comments / making javaDoc obsolete:

/**

* The id

* @return id

*/ 

public long getId(){

    return this.id;

} 

This example is so trivial, the most of the programmers would say one of those sentences: 

• it's ok, any programmer with a little experience is able to understand that.
• if a programmer does not understand that, then he is probabily on the false job
• it would be better without comments.
• it was auto-generated from eclipse. 
• My checkstyle tool would fail if a did not comment it.

it sounds legtmin right? Well, if i was forced to do that, i would probabily say to my boss:

hey boss, i know you need me to do the work XYZ, but i have to rewrite (even better repeat)  some pieces of my code to accomplish the rules we have in your company

What do you think, he would say? OK, i think you got it...let's jump this part and see how it should be and why!

Good example 1: 

/**

* With this id you are able to retrieve the object from the 

* database by calling {@link DAO#get(id)} 

* 

* @return id from the object to be retrieved

*/ 

public long getId(){

    return this.id;

} 

1 rule: we comment not what, but why we do something.

2. rule: we write an example how to use it, because in a year nobody knows that anymore

3. rule: writing a good comment, motivates and encourages junior programmers to do it correctly also.

4. rule: the javaDoc does not become obsolete this way and really helps

5. rule: a good comment can reduce maintenance efforts, when a bug is issued

6. rule: agility has nothing to do with zero documents! thats not the meaning. agility, means sustainability means, re-usability, understandable clean code and so on....

Do you want to improve your development skills? Follow: @algoritmo4j

An other common violation of the DRY principle is this one here :

Bad example 2 - DRY violation unconsciously:

/**comment ommited */ 

public void doThis(Object o){

    if(o !=null){

         // do something here... 

        }

} 

/**comment ommited */ 

public void doThat(Object o){

    if(o !=null){

         // do something here... 

        }

} 

this is an also very trivial example, but a really good one. such constructs are very often. instead of doing this way, do better this way here:

Good example 2: 

/**comment ommited */ 

public void doThis(Object o){

    doNotAllowNull ( o ) ;    

     // do something here... 

} 

/**comment ommited */ 

public void doThat(Object o){

    doNotAllowNull ( o ) ;    

     // do something here...

} 

/**comment ommited */ 

private <T>  void  doNotAllowNull(T anyObjectOfYourChoice){

    final String msg = "YourExceptionHelpMessage"; 

    if( anyObjectOfYourChoice  == null){

          throw new NullPointerException(msg);

        }

} 

Or this way here:

/**comment ommited */ 

private <T>  boolean  isNotNull(T anyObjectOfYourChoice){

    return ( anyObjectOfYourChoice != null ) ?  true  :  false ; 

} 

Even better: 

Even better it would be to define an interface and a class that does that for you so that you don't have to write or implement it always from the scratch. you just have to delegate it to this class.

Do you want to stay up to date?

bookmark www.treslines.com or follow: @algoritmo4j

Please rat it by clicking the google+1 or leaving some constructive comments or some bad examples from your companies and how you solve them. i also wanna learn from you. The next lesson will be: The KISS Principle. Stay connected and follow me. Do not miss it.

😱👇 PROMOTIONAL DISCOUNT: BOOKS AND IPODS PRO 😱👇

Be sure to read, it will change your life!

Show your work by Austin Kleon: https://amzn.to/34NVmwx

This book is a must read - it will put you in another level! (Expert)

Agile Software Development, Principles, Patterns, and Practices: https://amzn.to/30WQSm2

Write cleaner code and stand out!

Clean Code - A Handbook of Agile Software Craftsmanship: https://amzn.to/33RvaSv

This book is very practical, straightforward and to the point! Worth every penny!

Kotlin for Android App Development (Developer's Library): https://amzn.to/33VZ6gp

Needless to say, these are top right?

Apple AirPods Pro: https://amzn.to/2GOICxy

😱👆 PROMOTIONAL DISCOUNT: BOOKS AND IPODS PRO 😱👆