[SP-pm] Documentação de cabeçalho de rotinas

Blabos de Blebe blabos em gmail.com
Domingo Janeiro 13 17:22:20 PST 2008


Boa noite,

Eu uso doxygen e recomendo.

Vc bate o olho no módulo/método/função e logo de cara tem um comentário
clean pra ajudar. Se vc utilizar o graphviz ele gera ainda diversos diagramas
interessantes, em html, man, pdf, ps, etc

Utilizei mais com C++ e PHP e desde então não abro mão.



On Jan 11, 2008 4:58 PM, Otávio Fernandes <otaviof em gmail.com> wrote:
> Lucas,
>
> Entendi. E concordo plenamente.
>
> Aqui na empresa usamos o doxygen, o qual eh muito difundido e
> utilizados pra projetos como o KDE. Particularmente eu gosto muito,
> veja um exemplo:
>
> #
> # @brief        edita uma linha na tabela syncldap, seguindo o id informado
> como parametro
> #
> # @param        id da linha que deve ter os seus valores modificados
> # @param        ldap hash contendo os campos a serem inseridos no banco de dados
> #
> #                       Ex.:
> #
> #                       %ldap = (
> #                               syncbases_id    => "",
> #                               name                    => "",
> #                               addr                    => "",
> #                               ldap_port               => "",
> #                               ldap_user               => "",
> #                               ldap_pass               => "",
> #                               ldap_base               => "",
> #                               ldap_filter     => "",
> #                               ldap_uid                => "",
> #                               ldap_mail               => "",
> #                       ); ### Aten&ccedil;&atilde;o: com parenteses ###
> #
> # @author       Otavio Fernandes <otavio em empresa.com>
> # @date         30/07/07 - Segunda-feira
> #
> # @return       verdadeiro ou falso
>
> #
>
> um abraco,
>
> --
>  | --
>  | Otávio Fernandes < otaviof | gmail | com >
>  | FreeBSD 7.0-PRERELEASE && GNU/Linux User: 283.396
>  | (( Especial Programação )) http://geekbr.podcastbrasil.com/ -- 0.15
>  | --
> _______________________________________________
> SaoPaulo-pm mailing list
> SaoPaulo-pm em pm.org
> http://mail.pm.org/mailman/listinfo/saopaulo-pm
>


Mais detalhes sobre a lista de discussão SaoPaulo-pm