Oi devs,
"Esqueci" de falar que estava usando o DiPasDoc ao invés do PasDoc - acho
que falei isto para alguns por icq.
[[ DiPasDoc: http://www.zeitungsjunge.de/delphi/pasdoc/ ]]
Por causa disto o formato de documentação para funções e procedures sofreu
uma ligeira alteração. O DiPasDoc não suporta ainda a tag @param que o
Pasdoc suporta (muito mal, mas suporta).
Então as coisas ficaram assim:
============================================
*procedures e funções*
No caso de procedures/funções que não sejam óbvias de entender - a maioria -
você
deve documentar pra q servem cada um dos parâmetros e o que a função retorna
(*
@code(parâmetro1) descrição do que deve ser passado.<BR>
@code(parâmetro1) - descrição do que deve ser passado.<BR>
@code(descrição) - do que é retornado, no caso de funções.<BR>
*)
function tantam(parâmetro1, parâmetro2...): algo;
============================================
O tutorial foi atualizado de acordo, vejam ele em
http://notes2.sourceforge.net/dev/wakka.php?wakka=DocumenteOCodigo
Lembrem-se de sempre documentar o código e de utilizar comentários em
trechos mais doidos. Isso é importante para o futuro do Notes - mas também
para nós mesmos nos acharmos no caso de dar aquele branco ou algo assim,
hehehehe
E desculpem pelo meu esquecimento. (Preciso de férias! heheheh)
Abraço,
Anderson
_________________________________________________________
Voce quer um iGMail protegido contra vírus e spams?
Clique aqui: http://www.igmailseguro.ig.com.br
Ofertas imperdíveis! Link: http://www.americanas.com.br/ig/
|
