Smell my Code. Code smell ? What’s code smell?

Code smell is any symptom in the source code of a program that possibly indicates a deeper problem. It is the process of identifying bad software program and altering in such a way that it does not alter the external behavior of the code, yet improves its internal structure. Code smell can even take a bad design and rework it into a good one.

Some common Coding smells:

  1. Duplicated code: identical or very similar code exists in more than one location.Long method: a method, function, or procedure that has grown too large.
  2. Large class: a class that has grown too large. See God object.
  3. Too many parameters: a long list of parameters in a procedure or function make readability and code quality worse.
  4. Feature envy: a class that uses methods of another class excessively.
  5. Inappropriate intimacy: a class that has dependencies on implementation details of another cclass.
  6. Lazy class / Freeloader: a class that does too little.
  7. Contrived complexity: forced usage of overly complicated design patterns where simpler design would suffice.
  8. Excessive use of literals: these should be coded as named constants, to improve readability and to avoid programming errors. Additionally, literals can and should be externalized into resource files/scripts where possible, to facilitate localization of software if it is intended to be deployed in different regions.
  9. Ubercallback: a callback that is trying to do everything

Determining what is and is not a code smell is often a subjective judgment, and will often vary by language, developer and development methodology.

There are some tools such as Checkstyle, PMD and FindBugs for Java, to automatically check for certain kinds of code smells.

 

Playframework CRUD module error [admin module:crud]

Including the playframework CRUD module but getting the error -

~ Invalid route definition : * admin module:crud

Solution:
The Controller objects has to be plural (must end with ‘s’). The controller’s class name has to be the model class name with a final ‘s’.

For example,  If we have Customer.java model object, the controller object extending CRUD must be Customer*s*.java

package controllers;

public class Customers extends CRUD {

}