Vi tittar på en metod definierad i ett interface och funderar på vilken information som är duplicerad.
/**
* Create employee
**/
public void createEmployee(Employee employee);
Det första vi kan stryka är kommentaren. Den tillför inget som inte metodsignaturern redan beskriver.
Sedan kan man fundera på om metodnamnet är lämpligt. Vi duplicerar ordet employee två gånger. Vi testar att ta bort ordet Employee från CreateEmployee och tittar på resultatet.
public void create(Employee employee);
Metodsignaturer beskriver precis samma sak som det första exemplet. Den innehåller ingen kommentar av flera anledningar
- Kommentaren i exemplet tillför inget mervärde för koden. Det enda del tillför är mer text att läsa.
- Kommentaren kommer med hög sannolikhet att bli felaktig.Tex om man använda automatiskt refaktorering (ändra på ett ställe och alla ställen som använder samma kod uppdateras i hela kodbasen) är det inte troligt att kommentaren kommer att uppdateras. Alltså kommer koden snart innehålla felaktiga kommentarer
Inga kommentarer:
Skicka en kommentar