[SP-pm] Documentação de cabeçalho de rotinas
Otávio Fernandes
otaviof em gmail.com
Sexta Janeiro 11 10:58:57 PST 2008
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çã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
| --
Mais detalhes sobre a lista de discussão SaoPaulo-pm