[Notes2-team] RE: notes2-team digest, Vol 1 #247 - 2 msgs
Brought to you by:
andersonrb
Menu
▾
▴
[Notes2-team] RE: notes2-team digest, Vol 1 #247 - 2 msgs
|
From: Joao V. B. de M. <joa...@ho...> - 2003-12-15 09:17:19
|
Cada Um que for fazendo a documentação, escolherá uma dupla, como foi Decidido entre eu e robson (eu dei a ideia) ele aceitou. Estamos cuidando das Areas de PHP, ASP, e Java Script. Uma pequena Observação: Troquem o sistema aqui de Listam pois minha caixa de email lé tipo assim: 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 Ai esta commplicando muito para mim ler. Obrigado >From: not...@li... >Reply-To: not...@li... >To: not...@li... >Subject: notes2-team digest, Vol 1 #247 - 2 msgs >Date: Sun, 14 Dec 2003 20:09:13 -0800 > >Send notes2-team mailing list submissions to > not...@li... > >To subscribe or unsubscribe via the World Wide Web, visit > https://lists.sourceforge.net/lists/listinfo/notes2-team >or, via email, send a message with subject or body 'help' to > not...@li... > >You can reach the person managing the list at > not...@li... > >When replying, please edit your Subject line so it is more specific >than "Re: Contents of notes2-team digest..." > > >Today's Topics: > > 1. ** =?ISO-8859-1?Q?Documenta=E7=E3o_dos_fontes_do_Notes_?= > =?ISO-8859-1?Q?**?= (Anderson R. Barbieri) > >--__--__-- > >Message: 1 >Date: Mon, 15 Dec 2003 01:50:25 -0200 >From: "Anderson R. Barbieri" <no...@ig...> >To: not...@li... >Subject: [Notes2-team] ** >=?ISO-8859-1?Q?Documenta=E7=E3o_dos_fontes_do_Notes_?= > =?ISO-8859-1?Q?**?= >Reply-To: not...@li... > >This is a multi-part message in MIME format. >--------------030708010507050300030206 >Content-Type: text/plain; charset=ISO-8859-1; format=flowed >Content-Transfer-Encoding: quoted-printable > > >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 > > >--------------030708010507050300030206 >Content-Type: text/html; charset=us-ascii >Content-Transfer-Encoding: 7bit > ><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> ><html> ><head> > <meta http-equiv="Content-Type" content="text/html;charset=ISO-8859-1"> > <title></title> ></head> ><body text="#000000" bgcolor="#ffffff"> ><br> >Olá noteiros de todas as estâncias!<br> ><br> >Eis um início de esforço para termos uma >documentação dos fontes do >Notes!!!<br> ><a class="moz-txt-link-freetext" >href="http://notes2.sourceforge.net/dev/wakka.php?wakka=NotesSE2004">http://notes2.sourceforge.net/dev/wakka.php?wakka=NotesSE2004</a><br> ><br> >A partir de agora <b>POR FAVOR, TODOS</b> documentem todo o código >que >fizerem.<br> >Usaremos um utilitário chamado <u>pasdoc</u> pra gerar uma >documentação, pois ele cata<br> >os comentários do código e cria os HTMLs (exemplo feito com >os fontes >do notes atuais<br> ><a class="moz-txt-link-freetext" >href="http://notes2.sf.net/srcdocs.zip">http://notes2.sf.net/srcdocs.zip</a>). ><br> ><br> >Eu compilei o pasdoc pra windows usando os fontes do CVS. Eu recomendo >q usem está<br> >versão q compilei (a q tá no site deles não funciona, >só dá merda).<br> ><a class="moz-txt-link-freetext" >href="http://notes2.sf.net/pasdoc.zip">http://notes2.sf.net/pasdoc.zip</a><br> >O site do pasdoc é <a class="moz-txt-link-freetext" >href="http://pasdoc.sourceforge.net">http://pasdoc.sourceforge.net</a><br> ><br> ><br> ><a class="moz-txt-link-freetext" >href="http://notes2.sourceforge.net/dev/wakka.php?wakka=DocumenteOCodigo">http://notes2.sourceforge.net/dev/wakka.php?wakka=DocumenteOCodigo</a><br> >=====<br> ><h2>Documente o Código</h2> ><strong>Introdução</strong><br> >Para facilitar a entrada de novos desenvolvedores na equipe e as >contribuições de nossos usuários<br> >o código fonte do Notes precisa estar documentado. Para isto >usaremos o ><span class="missingpage">PasDoc</span>, um utilitário<br> >capaz de usar os comentários do código fonte para criar a >documentação. >Abaixo você aprende<br> >a documentar o código.<br> ><br> ><strong>Início de Unit</strong><br> ><tt>(**<br> >@abstract(NomeDaUnit - descrição.)<br> >@author(PrimeiroAutor <email @do.cara="">)<br> >@author(SegundoAutor <email @do.segundo="">)<br> >Descrição mais detalhada do que a unit faz, pra que >serve,etc.<br> >*)<br> >unit NomeDaUnit; ></email></email></tt><br> ><br> ><strong>Antes de DECLARAÇÕES de métodos, types, >constantes, records, >etc.</strong><br> ><tt>{descrição do que que o código faz usando um >comentário simples}<br> >declaração do type, constante, etc.;</tt><br> ><br> ><strong>Variáveis</strong><br> ><tt>nomeDaVariável: type; // pra que serve a variável, usando >comentário simples</tt><br> ><br> ><strong>procedures e funções</strong><br> >No caso de procedures/funções nque não sejam >óbvias de entender - a >maioria - você<br> >deve documentar pra q servem cada um dos parâmetros e o que a >função >retorna<br> ><tt>(**<br> >@param parâmetro1 descrição do que deve ser >passado.<br> >@param parâmetro1 descrição do que deve ser >passado.<br> >@result descrição do que é retornado, no caso de >funções.<br> >*)<br> >function tantam(parâmetro1, parâmetro2...): algo; ></tt><br> ><br> ><strong>Conclusão</strong><br> >é preciso ressaltar que apenas os comentários das >declarações contam, o >resto não<br> >aparece na documentação. É importante que você >vá comentando enquanto >cria o<br> >código, pois depois é um saco ter que abrir a unit e ir >comentando >procedure por procedure!<br> >Faça comentários objetivos. Lembre-se que um dia pode ser que >você >mesmo acabe tendo<br> >que ler a documentação e com certeza você não >vai querer ler algo mal >escrito :)<br> ><br> ><br> ><b></b>=====<br> ><br> >A minha idéia é distribuir duas versões do Notes SE >2004. Uma será o >Notes executável e outra<br> >será o código fonte. Penso que ambas devem vir com >instaladores, no >caso do fonte para que possamos<br> >obrigar o cara a concordar com a GPL antes de ter acesso aos fontes. Os >que estão realmente a fim<br> >de ajudar-nos vão concordar e desta vez terão alguma >documentação do >código a sua disposição.<br> ><br> >Era wilson! Ab a todos!<br> ><pre cols="120" class="moz-signature">-- >Anderson Rodrigues Barbieri >-------------------------------------------- >#Equipe do Notes - Coordenador/Desenvolvedor > >{ TAndInfo } >ICQ #149391850 / <a class="moz-txt-link-abbreviated" >href="mailto:no...@ig...">no...@ig...</a> >Notes - <a class="moz-txt-link-freetext" >href="http://notes.codigolivre.org.br">http://notes.codigolivre.org.br</a> >NotesDev - <a class="moz-txt-link-freetext" >href="http://notes2.sf.net/dev">http://notes2.sf.net/dev</a> >Fórum - <a class="moz-txt-link-freetext" >href="http://notes2.sf.net/forum">http://notes2.sf.net/forum</a> ></pre> ></body> ></html> > >--------------030708010507050300030206-- > > > > >--__--__-- > >_______________________________________________ >notes2-team mailing list >not...@li... >https://lists.sourceforge.net/lists/listinfo/notes2-team > > >End of notes2-team Digest _________________________________________________________________ MSN Messenger: converse com os seus amigos online. http://messenger.msn.com.br |
