Ol=E1 noteiros de todas as est=E2ncias!
Eis um in=EDcio de esfor=E7o para termos uma documenta=E7=E3o dos fontes =
do Notes!!!
http://notes2.sourceforge.net/dev/wakka.php?wakka=3DNotesSE2004
A partir de agora *POR FAVOR, TODOS* documentem todo o c=F3digo que fizer=
em.
Usaremos um utilit=E1rio chamado _pasdoc_ pra gerar uma documenta=E7=E3o,=
pois=20
ele cata
os coment=E1rios do c=F3digo e cria os HTMLs (exemplo feito com os fontes=
do=20
notes atuais
http://notes2.sf.net/srcdocs.zip).
Eu compilei o pasdoc pra windows usando os fontes do CVS. Eu recomendo q=20
usem est=E1
vers=E3o q compilei (a q t=E1 no site deles n=E3o funciona, s=F3 d=E1 mer=
da).
http://notes2.sf.net/pasdoc.zip
O site do pasdoc =E9 http://pasdoc.sourceforge.net
http://notes2.sourceforge.net/dev/wakka.php?wakka=3DDocumenteOCodigo
=3D=3D=3D=3D=3D
Documente o C=F3digo
*Introdu=E7=E3o*
Para facilitar a entrada de novos desenvolvedores na equipe e as=20
contribui=E7=F5es de nossos usu=E1rios
o c=F3digo fonte do Notes precisa estar documentado. Para isto usaremos o=
=20
PasDoc, um utilit=E1rio
capaz de usar os coment=E1rios do c=F3digo fonte para criar a documenta=E7=
=E3o.=20
Abaixo voc=EA aprende
a documentar o c=F3digo.
*In=EDcio de Unit*
(**
@abstract(NomeDaUnit - descri=E7=E3o.)
@author(PrimeiroAutor )
@author(SegundoAutor )
Descri=E7=E3o mais detalhada do que a unit faz, pra que serve,etc.
*)
unit NomeDaUnit;
*Antes de DECLARA=C7=D5ES de m=E9todos, types, constantes, records, etc.*
{descri=E7=E3o do que que o c=F3digo faz usando um coment=E1rio simples}
declara=E7=E3o do type, constante, etc.;
*Vari=E1veis*
nomeDaVari=E1vel: type; // pra que serve a vari=E1vel, usando coment=E1ri=
o simples
*procedures e fun=E7=F5es*
No caso de procedures/fun=E7=F5es nque n=E3o sejam =F3bvias de entender -=
a=20
maioria - voc=EA
deve documentar pra q servem cada um dos par=E2metros e o que a fun=E7=E3=
o retorna
(**
@param par=E2metro1 descri=E7=E3o do que deve ser passado.
@param par=E2metro1 descri=E7=E3o do que deve ser passado.
@result descri=E7=E3o do que =E9 retornado, no caso de fun=E7=F5es.
*)
function tantam(par=E2metro1, par=E2metro2...): algo;
*Conclus=E3o*
=E9 preciso ressaltar que apenas os coment=E1rios das declara=E7=F5es con=
tam, o=20
resto n=E3o
aparece na documenta=E7=E3o. =C9 importante que voc=EA v=E1 comentando en=
quanto cria o
c=F3digo, pois depois =E9 um saco ter que abrir a unit e ir comentando=20
procedure por procedure!
Fa=E7a coment=E1rios objetivos. Lembre-se que um dia pode ser que voc=EA =
mesmo=20
acabe tendo
que ler a documenta=E7=E3o e com certeza voc=EA n=E3o vai querer ler algo=
mal=20
escrito :)
**=3D=3D=3D=3D=3D
A minha id=E9ia =E9 distribuir duas vers=F5es do Notes SE 2004. Uma ser=E1=
o=20
Notes execut=E1vel e outra
ser=E1 o c=F3digo fonte. Penso que ambas devem vir com instaladores, no c=
aso=20
do fonte para que possamos
obrigar o cara a concordar com a GPL antes de ter acesso aos fontes. Os=20
que est=E3o realmente a fim
de ajudar-nos v=E3o concordar e desta vez ter=E3o alguma documenta=E7=E3o=
do=20
c=F3digo a sua disposi=E7=E3o.
Era wilson! Ab a todos!
--=20
Anderson Rodrigues Barbieri
--------------------------------------------
#Equipe do Notes - Coordenador/Desenvolvedor
{ TAndInfo }
ICQ #149391850 / no...@ig...
Notes - http://notes.codigolivre.org.br
NotesDev - http://notes2.sf.net/dev
F=F3rum - http://notes2.sf.net/forum
|
