Publicidade   
 você está aqui: phpbrasil.com    artigos    artigo  
 
:: novos artigos ::

:: recomendado ::

MYSQL & MSQL

Compre esse livro no Submarino.com.br

:: publicidade ::


:: novos scripts ::

:: elenco phpbrasil ::

fccd
Pontos: 10353

Visite a página de perfil de leo genilhuPHPDOC – Documentando bem seu código.
por leo genilhu
Lista de Categorias  |  Contribua um Novo Artigo  |  Entre em Contato Conosco

Vamos falar um pouco sobre documentação de códigos php usando a ferramenta PHPDoc ou PHPDocumentor. O PHPDoc foi baseado no JAVADoc da Sun e tem como objetivo padronizar a documentação de códigos PHP.
Vote aqui!
Média de Votos Atual: 4.00
Total de Votos: 6
Nota:   

Olá pessoal, depois de um bom tempo sem escrever aqui volto a todo vapor com uma série de artigos sobre documentação.

Hoje vamos falar um pouco sobre documentação de códigos php usando a ferramenta PHPDoc ou PHPDocumentor. O PHPDoc foi baseado no JAVADoc da Sun e tem como objetivo padronizar a documentação de códigos PHP. Ele lê o código e analisa gramaticalmente procurando por tags especiais. A partir delas extrai toda documentação usando diferentes formatos (pdf, xml, html, chm Windows help e outros). Todas as tags especiais são escritas dentro do comentários do php /* comentários */ e necessariamente começam com o @ (arroba).

Descrição de algumas tags especiais:

@access Especifica o tipo de acesso(public, protected e private).
@author Especifica o autor do código/classe/função.
@copyright Especifica os direitos autorais.
@deprecated Especifica elementos que não devem ser usados.
@exemple Definir arquivo de exemplo, $path/to/example.php
@ignore Igonarar código
@internal Documenta função interna do código
@link link do código http://www.exemplo.com
@see
@since
@tutorial
@name Especifica o apelido(alias).
@package Especifica o nome do pacote pai, isto ajuda na organização das classes.
@param Especifica os paramêtros muito usado em funções.
@return Especifica o tipo de retorno muito usado em funções.
@subpackage Especifica o nome do pacote filho.
@version Especifica a versão da classe/função.
Inline { @internal





<< Anterior 1 2 3 Próxima >>

 
Imprimir  |  Enviar para um Amigo


Comentários de Usuários

pear
publicado por Daniel Ribeiro - 2006-07-18 10:00:37

vale lembrar tbm que este mesmo padrao de escrita de codigo.. eh tbm utilizado nos pacotes da pear http://pear.php.net/manual/en/standards.php

otimo artigo
publicado por Aurelio Saraiva - 2006-07-18 10:37:10

Bom seu artigo esta otimo, é muito bom os programadores novos começarem a aprender a documentar seus codigo.
Tem amigos meus que dizem: fazer um software é facil dificil e documentar tudo.

Artigo semelhante
publicado por Wescley Costa - a.k.a Narixx - 2006-07-25 07:45:14

Para mais aprofundamento tem tb um artigo sobre o PHP Doc escrito pelo Rodrigo Rodrigues...
Segue o link: http://phpbrasil.com/articles/article.php/id/916


Att,

Wescley Costa

Mto Bom
publicado por ksamador - 2006-08-02 04:13:13

Muito bom esse artigo, eu não tinha o costume de documentar o código php sempre documentei a regra de negócio somente.

duvidas
publicado por red_slack - 2006-08-05 11:44:18

Bem amigos sou novo na area, mas tenho muito interesse em aprender e gostaria de saber mais como devo usar, como funciona essa documentação, isso é um programa que eu tenho que pegar pra fazer isso para mim, gostaria de mais detalhes sobre isso. VLW

Documentando Com ZEnd
publicado por Pablo Vanni - 2006-08-21 19:11:55

Eu uso a IDE da Zend e quando tento gerar a documentação em formato help do windows ele não funciona :(

Alguem já teve o mesmo problema ow sabe resolver?

Bacana
publicado por Diego Hellas - 2006-09-27 17:58:22

Eu já tinho ouvido falar muito o phpdoc, que é descendente do java doc correto? mas não tinha a mínima idéia de como funcionava, ams agora tive uma visão bem boa de como ele funciona.

Valeu!

bem explicado
publicado por gustavo pereira rodrigues - 2008-03-16 14:25:26

parabens, bem explicado, o exemplo ajudou basttante.

Publique os seus Comentários

Nome:
Email:
Título:
Comentário:

NOTA: Cadastre-se no site para poder publicar comentários.

 
webmaster: João Prado Maia   © 2000 - 2005 phpbrasil.com
Gerado em 1.255 segundos