PHPDOC – Documentando bem seu código.
Exemplo parte de código documentado com PHPDoc.
<?php
/**
* Comentário de cabeçalho de arquivos
* Esta classe de upload de fotos
*
* @author leo genilhu <leo@genilhu.com>
* @version 0.1
* @copyright GPL © 2006, genilhu ltda.
* @access public
* @package Infra_Estrutura
* @subpackage UploadGenilhu
* @example Classe uploadGenilhu.
*/
class uploadGenilhu {
/**
* Comentário de variáveis
* Variável recebe o diretório para gravar as fotos.
* @access private
* @name $diretorio
*/
var $diretorio = "" ;
/**
* Função para gravar imagem em diretório
* @access public
* @param String $imagem_nome
* @param String $diretorio
* @return void
*/
function upload_up($imagem_nome, $diretorio)
{
$tmp = move_uploaded_file($this->arquivo["tmp_name"], $diretorio);
return($tmp);
}
?>
<?php
/**
* Comentário de cabeçalho de arquivos
* Esta classe de upload de fotos
*
* @author leo genilhu <leo@genilhu.com>
* @version 0.1
* @copyright GPL © 2006, genilhu ltda.
* @access public
* @package Infra_Estrutura
* @subpackage UploadGenilhu
* @example Classe uploadGenilhu.
*/
class uploadGenilhu {
/**
* Comentário de variáveis
* Variável recebe o diretório para gravar as fotos.
* @access private
* @name $diretorio
*/
var $diretorio = "" ;
/**
* Função para gravar imagem em diretório
* @access public
* @param String $imagem_nome
* @param String $diretorio
* @return void
*/
function upload_up($imagem_nome, $diretorio)
{
$tmp = move_uploaded_file($this->arquivo["tmp_name"], $diretorio);
return($tmp);
}
?>
parabens, bem explicado, o exemplo ajudou basttante.
16/03/2008 2:25pm
(~17 anos atrás)
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!
Valeu!
27/09/2006 5:58pm
(~18 anos atrás)
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?
Alguem já teve o mesmo problema ow sabe resolver?
21/08/2006 7:11pm
(~18 anos atrás)
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
05/08/2006 11:44am
(~18 anos atrás)
Muito bom esse artigo, eu não tinha o costume de documentar o código php sempre documentei a regra de negócio somente.
02/08/2006 4:13am
(~18 anos atrás)
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
Segue o link: http://phpbrasil.com/articles/article.php/id/916
Att,
Wescley Costa
25/07/2006 7:45am
(~18 anos atrás)
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.
Tem amigos meus que dizem: fazer um software é facil dificil e documentar tudo.
18/07/2006 10:37am
(~18 anos atrás)
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
18/07/2006 10:00am
(~18 anos atrás)