seja bem vindo ao forum eof, caso nao seja cadastrado se cadastre para poder visualizar todo o conteudo ^^

Você não está conectado. Conecte-se ou registre-se

 » Programação Web » PHP » PHPDocs

PHPDocs

Ir em baixo  Mensagem [Página 1 de 1]

1 PHPDocs em Qui Fev 06, 2014 10:41 pm

yer123

avatar
avançado
avançado
.: 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.

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, [Você precisa estar registrado e conectado para ver este link.] e [Você precisa estar registrado e conectado para ver este link.].

Chuck_Kill


_________________ASSINATURA_________________


"Não quero ser só mais um." - EU

2 Re: PHPDocs em Sex Fev 07, 2014 6:07 am

susp3it0virtu@l

avatar
master
master
Bacana mano \0/ fica mais facil de entender o codigo


_________________ASSINATURA_________________

[Você precisa estar registrado e conectado para ver esta imagem.]

Frases:

-"Ninguém baterá tão forte quanto a vida.Porém,não se trata de quão forte pode bater,se trata de quão forte pode ser atingido e continuar seguindo em frente.É assim que a vitória é conquistada" - Rocky Balboa

-"Um homem não está acabado quando enfrenta a derrota. Ele está acabado quando desiste." - Richard Nixon

-"Sometimes,you have to demo a threat to spark a solution" - Barnaby Jack

3 Re: PHPDocs em Sex Fev 07, 2014 12:40 pm

Kodo no Kami

avatar
master
master
muitas ide destaca esses comentários com cores diferente alguns ate usa esse tipo de informação como variaveis globais ^^


_________________ASSINATURA_________________
[Você precisa estar registrado e conectado para ver esta imagem.]
[Você precisa estar registrado e conectado para ver esta imagem.]

Contato:
Spoiler:

Contato:
Facebook: [Você precisa estar registrado e conectado para ver este link.]
Skype: hackerfts315
http://endoffile.umforum.net

4 Re: PHPDocs em Sex Fev 07, 2014 5:19 pm

yer123

avatar
avançado
avançado
Vdd caras... é bom tanto para entender o codigo como para adiantar esse processo e ficar mais organizado.
E por exemplo, o netbeans, quando aperta control + mouse hover, ele mostra informacoes da tag a partir disso


_________________ASSINATURA_________________


"Não quero ser só mais um." - EU

Conteúdo patrocinado


Voltar ao Topo  Mensagem [Página 1 de 1]

 » Programação Web » PHP » PHPDocs

Permissão deste fórum:
Você não pode responder aos tópicos neste fórum