Olá, estou com uma duvida em relação a documentação de código. Pergunto: O que é mais elegante, correto fazer? Para todas as classe em meu sistema utilizo interfaces pré-definidas. Onde devo colocar a documentação /** … **/ de cada método, nos metodos declarados nas interfaces, ou nos metodos implementados dentro da classe?
Duvida - Documentação de Codigo
R
1 Resposta
Olá meu caro amigo rstw, em relação à documentação de códigos, em específico a sua pergunta vale lembrar que a doumentação é uma das partes mais importantes quando se trata de legibilidade. A documentação depende muito, varia de programador para programador. Eu no seu caso, documentaria por partes.
Explicaria o que faz cada bloco da classe, e na implementação explicaria o que faz a classe na integra, de onde vem etc.
!A e cuidado com redundância de informação.
Abraços.
Criado 18 de fevereiro de 2011
Ultima resposta 18 de fev. de 2011
Respostas 1
Participantes 2
Alura Git Flow: entenda o que é, como e quando utilizar Entenda o que é Git Flow, como funciona seu fluxo com branches como Master, Develop, Feature, Release e Hotfix, além de vantagens e desvantagens.
Casa do Codigo Ontologias e Web Semantica: Do conceito a aplicacao Por Ivam Galvao Filho — Casa do Codigo