Início
.: Oque é :.
PHP Doc é uma forma muito útil e organizada de se documentar seus códigos em PHP.
Ela tem uma sintaxe simples, que deve ser um comentário em bloco, com um asterisco na frente de cada linha.
Essa documentação tem basicamente uma ordem que é seguida: Descrição curta, descrição longa, e por fim as tags.
Essas tags são responsáveis por trazer algumas informações que normalmente são comuns para outros softwares, e que é bom se documentar.
OBS: As tags devem ser iniciadas por @ e seu nome deve está correto, ou não é considerada uma.
Veja a lista de tags vistas como sendo as mais importantes por mim:
.: Author :.
Simplismente, essa tag é utilizada para mostrar o nome do autor do código.
.: Copyright :.
Exibe informações sobre o Copyright do software (nome + data).
.: Global :.
Essa tag serve tanto para documentar uma variável global, tanto para usar em funções e/ou méthodos.
.: Link :.
Serve para colocar um hipertexto no blog, e agora perceba a diferença com a tag notificatnione.
.: Name :.
Exibe o nome que a variável está a receber.
.: Package :.
Documenta um grupo de classes ou funções não relacionais.
.: Param :.
Documenta o tipo de parâmetros das funções.
.: Staticvar :.
Usada para documentar variáveis estáticas em funções ou classes por exemplo.
.: Todo :.
Usada para marcar coisas a ser feita no código. Como um upgrade em uma função por exemplo.
.: Tutorial :.
Exibe um link para um tutorial referente ao código. Apenas tutorial!
.: Version :.
Mostra a versão corrente da ferramenta. A nomenclatura muda de empresa para empresa.
Para mais informações, [Tens de ter uma conta e sessão iniciada para poderes visualizar este link] e [Tens de ter uma conta e sessão iniciada para poderes visualizar este link].
Chuck_Kill
PHP Doc é uma forma muito útil e organizada de se documentar seus códigos em PHP.
Ela tem uma sintaxe simples, que deve ser um comentário em bloco, com um asterisco na frente de cada linha.
Essa documentação tem basicamente uma ordem que é seguida: Descrição curta, descrição longa, e por fim as tags.
Essas tags são responsáveis por trazer algumas informações que normalmente são comuns para outros softwares, e que é bom se documentar.
OBS: As tags devem ser iniciadas por @ e seu nome deve está correto, ou não é considerada uma.
Veja a lista de tags vistas como sendo as mais importantes por mim:
.: Author :.
Simplismente, essa tag é utilizada para mostrar o nome do autor do código.
.: Copyright :.
Exibe informações sobre o Copyright do software (nome + data).
.: Global :.
Essa tag serve tanto para documentar uma variável global, tanto para usar em funções e/ou méthodos.
.: Link :.
Serve para colocar um hipertexto no blog, e agora perceba a diferença com a tag notificatnione.
.: Name :.
Exibe o nome que a variável está a receber.
.: Package :.
Documenta um grupo de classes ou funções não relacionais.
.: Param :.
Documenta o tipo de parâmetros das funções.
.: Staticvar :.
Usada para documentar variáveis estáticas em funções ou classes por exemplo.
.: Todo :.
Usada para marcar coisas a ser feita no código. Como um upgrade em uma função por exemplo.
.: Tutorial :.
Exibe um link para um tutorial referente ao código. Apenas tutorial!
.: Version :.
Mostra a versão corrente da ferramenta. A nomenclatura muda de empresa para empresa.
- Código:
/**
* Explicação de PHP Doc
*
* Esse é um DocBlok (Bloco de Documentação)
* que serve para mostrar as funcionalidades
* e dar exemplo de como é o uso de um atributo
* muito interessante do php, que é o -> PHP Docs
*
* @autor Chuck_Kill
* @copyright EOF - 2014
* @link www.endoffile.umforum.net
* @version 1.0v
* @todo Colocar qualquer outra coisa nova aqui
*/
Para mais informações, [Tens de ter uma conta e sessão iniciada para poderes visualizar este link] e [Tens de ter uma conta e sessão iniciada para poderes visualizar este link].
Chuck_Kill
