Fluent Interfaces e documentação

1 resposta
brccosta

Caros,

Algum de vocês utiliza a técnica de Fluent Interfaces? Aqui na empresa estamos em uma discussão a respeito da necessidade de geração de javadoc para métodos e classes (a documentação é necessária vistos requisitos de grandes clientes). Alguns defendem a ideia que é necessário comentários para classes de domínio (POJO) assim como para seus atributos. Porém o impasse está na necessidade de geração de comentários para métodos fluentes, intuitivos. Por exemplo, qual a real necessidade de comentar e gerar documentação para o método: recuperarUsuarioPorID(…)?

Qual é a política na arquitetura de seus sistemas?

1 Resposta

Rodrigo_Sasaki

Eu particularmente não gosto de código comentado. Explico:

O comentário no código explica o que está acontecendo, sendo que um código bem escrito não precisaria de explicação (aprendi isso no Clean Code).

Se um método é conciso e bem nomeado, ele não precisa de comentário algum. Como no seu exemplo do recuperarUsuarioPorId. Não há necessidade de comentar.

Comentário justifica um código mal escrito. As vezes pode ser necessário, mas eu acho que deve ser evitado. O que deve “falar” o que acontece é o próprio código

Criado 30 de setembro de 2013
Ultima resposta 30 de set. de 2013
Respostas 1
Participantes 2