Follow treslines by email clicking Here!

Monday, July 25, 2011

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

How can i indicate the quality of my clean code to other developers ?
(Clean Code Quality Seal : Red)
Table of contents
How can i indicate the quality of my clean code to other developers ?
How can i indicate the grade of cleanness in my code?
How do i establish the quality seals ?
When do i know if i should clean the code ?
When do i not have to seal the class?
How can i make the seals reusable to the whole company?
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 can i indicate the quality of my clean code to other developers ?

Hi there! !n this blog i wanna give you some ideas, how we can exploit the synergy in the company to our favor. (clean code developers) If you are familiar with Clean Code Development (CCD) and with the degrees it exits (black, red, orange, yellow, green, blue, white) you probably know how hard it is, to measure or indicate the grade of cleanness in the code. Here are some ideas that leave you and your code significantly stand out from the crowd.
If you are not familiar with the clean code development's degree system take a look at this first: Link

How can i indicate the grade of cleanness in my code?

Well the main problem is how to indicate the grade of cleanness of a class or peace of code, so that anyone knows, how clean or how "dirty" is a class or peace of code. For this purpose i've established quality seals. Usually you'll have a lot of developers in different stages of the clean code degree's system doing their work in the company. (because of the rotation principle of the clean code system)  It is also usual that developers review their code or the code from others to ensure quality and uniformity of checkstyle, etc. Which automatically means that developers with different skills and clean code stages will pass thru the code doing inspections, corrections and so on.

How do i establish the quality seals ?

Well, now instead of put an eclipse auto-generated copyright comment on the top of each class, that no one reads anyway (for this type of copyright comments you have other channels today) you could place a clean code quality seal. Here are the seal's pattern a make to copy / paste in your code. you post a seal from your actual degree and only if you realy did follow the principles and practises from your degree's color.
/**
*<pre>
*  +---------------------------------------------------+
*  + CLEAN CODE SEAL: RED - 25.07.2011 - R. Ferrira    +
*  +---------------------------------------------------+ 
*</pre>
*/ 
/** 
*<pre>
*  +----------------------------------------------------+
*  + CLEAN CODE SEAL: ORANGE - 25.07.2011 - R. Ferreira +
*  +----------------------------------------------------+ 
*</pre>
*/ 
/** 
*<pre>
*  +----------------------------------------------------+
*  + CLEAN CODE SEAL: YELLOW - 25.07.2011 - R. Ferreira +
*  +----------------------------------------------------+ 
*</pre>
*/ 
/** 
*<pre>
*  +----------------------------------------------------+
*  + CLEAN CODE SEAL: GREEN - 25.07.2011 - R. Ferreira  +
*  +----------------------------------------------------+ 
*</pre>
*/  
/** 
*<pre>
*  +----------------------------------------------------+
*  + CLEAN CODE SEAL: BLUE - 25.07.2011 - R. Ferreira   +
*  +----------------------------------------------------+ 
*</pre>
*/

When do i know if i should clean the code ?

Well that's very simple. If you pass thru the code (review, testing or refactoring) and you are corrently in a other stage as the current posted quality seal, you shall apply the principles and rules of your current degree and seal if after that. A second seal would look like this:
/**
*<pre>
*  +----------------------------------------------------+
*  + CLEAN CODE SEAL: RED - 25.07.2011 - R. Ferreira    + 
*  +----------------------------------------------------+
*  + CLEAN CODE SEAL: GREEN - 25.07.2011 - H. Müller    +
*  +----------------------------------------------------+ 
*</pre>
*/

When do i not have to seal the class?

If you are currently in a degree that was already posted or if the class has all five seals already posted in it. With this simple "game" you'll learn a lot, become a very good professional and your company's code will be improved a lot. New developers (juniors) will be motivated and feel confortable in your company learning from the best developers.

How can i make the seals reusable to the whole company?

Well, that’s very simple. Just write annotations for it like this :
@CleanCodeSealRed
@CleanCodeSealOrange
@CleanCodeSealYellow
@CleanCodeSealGreen
@CleanCodeSealBlue

How could we improve the quality of this article ?

If the content of this article does not help you, so please tell us how to improve the quality of it by giving your contructive feedbacks at the end of this blog. If it was useful to you giving and resuming to you the most important aspects of the subject treated, saving you a lot of time, then help us to maintain this blog with a little appreciation. With a small amount of your choice you help us to cover the prime costs like:


Hosting, autors’s research work, editorial work, blog quality, motivation to make things better than others resulting in a very useful information pool for you and a lot of other developers.

Important : If you do not have the possibility to donate a little amount, than recommend this page to your friends. Thanks !





Source code convention tools

Literature, good books and references

How can i subscribe/feed this blog ?

Subscribe to: Post Comments (Atom)

How can i rate this blog ?

Press google+1 once !

Where do i find more clean code knowledge and gadgets?


No comments:

Post a Comment