Documentação

Olá pessoal, tudo bem?! Com certa frequência menosprezamos o valor do PHPDoc, porém o que é isso? ‘”PHPDoc” is a section of documentation which provides information on aspects of a “Structural Element”.’ PHP Fig – PSr’5 – Definitions “PHPDoc” é uma seção de documentação que fornece informações sobre aspectos de um “Elemento Estrutural”. Sua falta se dá no pior momento, onde necessitamos consultar um recurso e não encontramos nada sobre o mesmo, apenas as várias linhas de sua implementação. Abaixo pode-se observar um trecho de código sem o uso do PHPDoc. ...

Fala pessoal tudo tranquilo? Quem nunca se deparou com a necessidade de documentar o sistema que está desenvolvendo, para que outros programadores consigam realizar novas implementações, correções ou até mesmo consumir a API. Sabemos que a documentação é algo essencial e indispensável no desenvolvimento de softwares para garantir a longevidade de nossos sistemas. O PHP não fica para trás neste quesito, atualmente no PHP-FIG está em processo de “Draft” a PSR-5 visando um padrão para PHPDoc para comunidade PHP. Este post não visa analisar nem menos discutir sobre a PSR, e sim demostrar a criação de forma simples a documentação do nosso sistema. ...