Documentando seus programas PHP

Publicado por Breno Henrique Duarte de Oliveira em 15/05/2007

[ Hits: 9.908 ]

Blog: http://www.vipertech.com.br

 


Documentando seus programas PHP



Bom pessoal,

Muitos programadores tem o péssimo hábito de não documentar seus trabalhos e se esquecem que a lógica de programação pode variar de pessoa para pessoa. Pensando nisso a Sun MicroSystems elaborou o JavaDoc, que seria uma documentação a partir de comentários que fossem encontrados no seu código. Muito bom isso, assim enquanto eu programo já comento o código e ainda gero uma documentação né.

Produzir programas com documentação irá facilitar até mesmo para você futuramente. Imagina que você faz uma página de e-commerce e daqui 2 anos (sua página muito bem desenvolvida) o cliente pede um pequena alteração que aparentemente seria bem simples, mas você não se lembra de nada, afinal já passou tanto tempo e novos projetos vem e vão. Imagina como você estaria se batendo de raiva, sendo que poderia ter tudo comentando e documentado e na hora da manutenção você iria direto ao problema.

Hoje desenvolvo a maior parte do meu tempo em PHP e sentindo falta do JavaDoc. Procurei ver se existia algo similar para PHP e para minha felicidade tem sim:
Mas com a febre que se tornou o AJAX, que tal então documentar também seus arquivos JavaScript com http://jsdoc.sourceforge.net/? Que ótimo, assim você não irá se xingar quando tiver que dar manutenção em suas páginas.

Bom, logo mais irei postar como instalar e como comentar seus código.

Abraços e visitem o blog da ViperTech.

Outras dicas deste autor

Portabilidade de métodos construtores em PHP

Validar todo o form de maneira dinâmica

Leitura recomendada

PHP - Utilizando Chainning

Slack - Ferramenta de comunicação em equipe (PC, Android e iOS)

Depurando com o PHP

Entenda a metodologia ágil Scrum

Verificando se algum parâmetro foi passado via GET para uma página PHP sem precisar testar um a um

  

Comentários

Nenhum comentário foi encontrado.



Contribuir com comentário




Patrocínio

Site hospedado pelo provedor RedeHost.
Linux banner
Linux banner

Destaques

Artigos

Dicas

Tópicos

Top 10 do mês

Scripts