Blog Intermol

Arquivo de Março de 2008

Como documentar seu PHP - phpDocumentor

Se você já trabalhou em um projeto grande, sabe que documentar o código é fundamental. Afinal de contas, como se lembrar de todas as funções e classes específicas do projeto?

Não tema, phpDocumentor está aí para nos salvar. A partir de certos tags de comentário que você coloca no seu PHP, o phpDocumentor monta uma documentação completa - bonitinha e muito prática - do seu projeto, com todas as variáveis que você quer mostrar, dependências, etc. Um pequeno exemplo:

/**
* Pequeno exemplo do que pode ser feito com o phpDocumentor. Cheque se o usuário está logado e some até dois números.
* @uses EstaLogado
* @param int $a Aqui é o primeiro número a ser adicionado.
* @param int $b O segundo número a ser adicionado, se não definido será 0.
* @return int O resultado de $a+$b
*/
function AeB($a, $b=0)
{
EstaLogado();
return $a+$b;
}

Na documentação gerada pelo phpDocumentor você vai encontrar algo como:

AeB (line 431)

Pequeno exemplo do que pode ser feito com o phpDocumentor. Cheque se o usuário está logado e some até dois números.

* return: O resultado de $a+$b.
* uses: EstaLogado

int AeB (int $a[, int $b = 0])

* int $a: Aqui é o primeiro número a ser adicionado.
* int $b: O segundo número a ser adicionado, se não definido será 0.

Mais informações em http://phpdoc.org/

1 comentário »

Mudar o usuário do Apache

Se você quer que o seu httpd rode com um usuário ou grupo diferente, você deve iniciar o httpd como root e depois trocar.

User/Group: o nome ou número do usuário ou grupo que você quer que o Apache use. Fique atento à segurança.

<IfModule !mpm_netware_module>
User ###SEU_USERNAME_AQUI###
Group ###SEU_GRUPO_AQUI###
</IfModule>

Sem comentários »