Code Smells : The Manual [Part 1]

By -
       Code Smells
By the definition i found in 
 Wikipedia, code smell is: "In computer programming, code smell is any symptom in the source code of a program that possibly indicates a deeper problem."
We do mistakes while we code. Its very certain. Some of us know about the smell while we code, others don't. But if someone just avoid the common smells in coding, his/her code will be increased a lot in quality. So, to write a quality code, we must know what are the code smells and we MUST avoid it. 
My personal opinion is, don't be a procrastinator in coding. Remove the smells after a single method or at least after completing a feature. 
In below these are the code smells that a beginner in coding should know. I will add more explanation to each of the smells in future. 
[Black circled point is the name of the smell and while circled point is the solution to remove the smell from your code.]
  • Inappropriate naming
    • rename it
  • Comments
    • extract method
    • rename method
    • introduce assertion
  • Dead code
    • delete
  • Duplicated code
    • extract method
    • pull up field
    • form template method
    • substitute algorithm
  • Primitive obsession
    • extract class
    • replace data value with object
    • replace type code with class
    • introduce parameter object
    • replace array with object
  • Large class
    • extract class
    • replace type code with class/subclass
    • replace type code with state/strategy
    • replace conditional with polymorphism
    • extract interface
    • duplicate observer data
  • Lazy class
    • inline class
    • collapse hierarchy
  • Long method
    • extract method
    • replace temp with query
    • introduce parameter object
    • preserve whole object
    • replace method with method object
    • decompose conditional  
  • Long parameter list
    • introduce parameter object
    • replace parameter with method
    • preserve whole object
  • Switch statements
    • replace type code with polymorphism
    • replace type code with state/ strategy
    • replace parameter with explicit methods
    • introduce null object
  • Speculative generality
    • collapse hierarchy
    • inline class
    • remove parameter
    • rename method
  • Feature envy
    • move field
    • move method
    • extract method
  • Temporary field
    • extract method

Comments

Post a Comment

Popular posts from this blog

Dropbox as SVN Repository

By -
Image
Version controlling is one of the most important concepts in software development. It helps us to maintain different version of files and folders in a very easy way among different peoples. One of the most popular versions controlling system is SVN.  This post is not about describing the features of SVN, rather it will focus some advanced issues here. The most critical (and important) problem I faced while working in online distributed team is to maintain the codes among my different team mates. Well, there are many free online SVN servers out there which will provide you space to store your SVN repository, but there is another way you can bypass those SVN server if you don’t want to put your code on their servers. Below are the steps. 1. Setup environment Download  TortoiseSVN  and install. 2. Create folder 2.1 Go to your Dropbox folder and create a new folder named 'DropboxSvnRepository' 3. Create repository 3.1 Right click on the 'D
Read more

While Loop and Variable Casting in SQL Script

By -
Sometimes ago, I needed to insert bulk data to one of my table. I was needed a loop which will insert the data one by one. Previously I did that using a console application. But now I find a better solution using SQL Script. Below is the SQL I used. It is self explanatory. DECLARE @i int = 0 declare @suffix varchar (20) WHILE @i < 20 BEGIN     SET @i = @i + 1     set @suffix = CAST(@i AS varchar (20))     /* do some work */     INSERT INTO [dbo].[Customer]            ([FirstName]            ,[LastName]            ,[Phone]            ,[Email])      VALUES            ('F'+@suffix            ,'L'+@suffix            ,'Ph'+@suffix            ,'Em'+@suffix            ) END Those who are interested to test in your environment, use the below sql to create the table quickly. CREATE TABLE [dbo].[Customer]( [Id] [int] IDENTITY(1,1) NOT NULL, [FirstName] [varchar](50) NOT NULL, [LastName] [varchar](50) NOT NULL, [Phone] [varchar
Read more