Estou trabalhando em um projeto "código-espaguete" e, enquanto corrigo bugs e implemento novos recursos, também faço refatoração para tornar o código testável por unidade.
O código geralmente é tão fortemente acoplado ou complicado que a correção de um pequeno bug resultaria na reescrita de muitas classes. Então, decidi desenhar uma linha em algum lugar do código em que paro de refatorar. Para deixar isso claro, deixo alguns comentários no código que explicam a situação, como:
class RefactoredClass {
private SingletonClass xyz;
// I know SingletonClass is a Singleton, so I would not need to pass it here.
// However, I would like to get rid of it in the future, so it is passed as a
// parameter here to make this change easier later.
public RefactoredClass(SingletonClass xyz) {
this.xyz = xyz;
}
}
Ou outro pedaço de bolo:
// This might be a good candidate to be refactored. The structure is like:
// Version String
// |
// +--> ...
// |
// +--> ...
// |
// ... and so on ...
//
Map map = new HashMap<String, Map<String, Map<String, List<String>>>>();
isso é uma boa ideia? O que devo ter em mente ao fazer isso?
refactoring
comments
Uooo
fonte
fonte
Respostas:
Se você alocou tempo para concluir sua refatoração, e se realmente o fizer, então sim - funcionará.
Os IDEs modernos têm uma opção para encontrar e mostrar linhas TODO. Você deve verificá-los de vez em quando e tentar reduzir o número deles sempre que puder.
fonte
Gostaria de fazer
/// @todo
comentários sobre essas considerações para doxygen ou uma tag personalizada fácil de instalar para javadoc , para que ela seja extraída automaticamente para a seção todo dos documentos da API. Comentários simples serão ignorados com muita facilidade e, eventualmente, se perderão nas profundezas do código.[Editar] BTW: essa é uma boa ideia:
Penso que (por experiência!), A refatoração pode ser muito perigosa, especialmente quando ainda não há testes de unidade. Portanto, é melhor restringir seu trabalho extra (ao corrigir bugs, etc.) ao adicionar comentários ao todo ... Todos sabemos: sempre que possível;)
fonte