Re: [Notes2-team] RE: notes2-team digest, Vol 1 #247 - 2 msgs
Brought to you by:
andersonrb
Menu
▾
▴
Re: [Notes2-team] RE: notes2-team digest, Vol 1 #247 - 2 msgs
|
From: Anderson R. B. <no...@ig...> - 2003-12-15 16:58:00
|
Joao, Eu dei uma olhada nas tuas opcoes de configuracao da lista e vi que tu=20 marcou a opcao para receber as mensagens em plain text. E por isto que tu esta=20 tendo problemas: o mailman tenta converter as mensagens html para plaintext e obviamente=20 isto naum da em boa coisa. Tente mudar as configuracoes pra receber as msgs em HTML... Quanto a organizacao da documentacao do Notes, que areas sao estas "PHP,=20 ASP, e Java Script". Nao combinamos nada conectado a estas linguagens. A documentacao eh=20 sobre o Notes, nao sobre linguagens... nao to entendendo nada. Alguem pode me explicar isto=20 direito??? Ab. Anderson Joao Vagner Brito de Medeiros wrote: > Cada Um que for fazendo a documenta=E7=E3o, escolher=E1 uma dupla, como= foi=20 > Decidido entre eu e robson (eu dei a ideia) ele aceitou. > > Estamos cuidando das Areas de PHP, ASP, e Java Script. > > Uma pequena Observa=E7=E3o: Troquem o sistema aqui de Listam pois minha= =20 > caixa de email l=E9 tipo assim: > Usaremos um utilit=3DE1rio chamado _pasdoc_ pra gerar uma=20 > documenta=3DE7=3DE3o,=3D > pois=3D20 > ele cata > os coment=3DE1rios do c=3DF3digo e cria os HTMLs (exemplo feito com os=20 > fontes=3D > do=3D20 > > 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. ** =3D?ISO-8859-1?Q?Documenta=3DE7=3DE3o_dos_fontes_do_Notes_?=3D >> =3D?ISO-8859-1?Q?**?=3D (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] **=20 >> =3D?ISO-8859-1?Q?Documenta=3DE7=3DE3o_dos_fontes_do_Notes_?=3D >> =3D?ISO-8859-1?Q?**?=3D >> Reply-To: not...@li... >> >> This is a multi-part message in MIME format. >> --------------030708010507050300030206 >> Content-Type: text/plain; charset=3DISO-8859-1; format=3Dflowed >> Content-Transfer-Encoding: quoted-printable >> >> >> Ol=3DE1 noteiros de todas as est=3DE2ncias! >> >> Eis um in=3DEDcio de esfor=3DE7o para termos uma documenta=3DE7=3DE3o = dos=20 >> fontes =3D >> do Notes!!! >> http://notes2.sourceforge.net/dev/wakka.php?wakka=3D3DNotesSE2004 >> >> A partir de agora *POR FAVOR, TODOS* documentem todo o c=3DF3digo que=20 >> fizer=3D >> em. >> Usaremos um utilit=3DE1rio chamado _pasdoc_ pra gerar uma=20 >> documenta=3DE7=3DE3o,=3D >> pois=3D20 >> ele cata >> os coment=3DE1rios do c=3DF3digo e cria os HTMLs (exemplo feito com os= =20 >> fontes=3D >> do=3D20 >> notes atuais >> http://notes2.sf.net/srcdocs.zip). >> >> Eu compilei o pasdoc pra windows usando os fontes do CVS. Eu=20 >> recomendo q=3D20 >> usem est=3DE1 >> vers=3DE3o q compilei (a q t=3DE1 no site deles n=3DE3o funciona, s=3D= F3 d=3DE1=20 >> mer=3D >> da). >> http://notes2.sf.net/pasdoc.zip >> O site do pasdoc =3DE9 http://pasdoc.sourceforge.net >> >> >> http://notes2.sourceforge.net/dev/wakka.php?wakka=3D3DDocumenteOCodigo >> =3D3D=3D3D=3D3D=3D3D=3D3D >> >> >> Documente o C=3DF3digo >> >> *Introdu=3DE7=3DE3o* >> Para facilitar a entrada de novos desenvolvedores na equipe e as=3D20 >> contribui=3DE7=3DF5es de nossos usu=3DE1rios >> o c=3DF3digo fonte do Notes precisa estar documentado. Para isto=20 >> usaremos o=3D >> =3D20 >> PasDoc, um utilit=3DE1rio >> capaz de usar os coment=3DE1rios do c=3DF3digo fonte para criar a=20 >> documenta=3DE7=3D >> =3DE3o.=3D20 >> Abaixo voc=3DEA aprende >> a documentar o c=3DF3digo. >> >> *In=3DEDcio de Unit* >> (** >> @abstract(NomeDaUnit - descri=3DE7=3DE3o.) >> @author(PrimeiroAutor ) >> @author(SegundoAutor ) >> Descri=3DE7=3DE3o mais detalhada do que a unit faz, pra que serve,etc. >> *) >> unit NomeDaUnit; >> >> *Antes de DECLARA=3DC7=3DD5ES de m=3DE9todos, types, constantes, recor= ds,=20 >> etc.* >> {descri=3DE7=3DE3o do que que o c=3DF3digo faz usando um coment=3DE1ri= o simples} >> declara=3DE7=3DE3o do type, constante, etc.; >> >> *Vari=3DE1veis* >> nomeDaVari=3DE1vel: type; // pra que serve a vari=3DE1vel, usando=20 >> coment=3DE1ri=3D >> o simples >> >> *procedures e fun=3DE7=3DF5es* >> No caso de procedures/fun=3DE7=3DF5es nque n=3DE3o sejam =3DF3bvias de= =20 >> entender -=3D >> a=3D20 >> maioria - voc=3DEA >> deve documentar pra q servem cada um dos par=3DE2metros e o que a=20 >> fun=3DE7=3DE3=3D >> o retorna >> (** >> @param par=3DE2metro1 descri=3DE7=3DE3o do que deve ser passado. >> @param par=3DE2metro1 descri=3DE7=3DE3o do que deve ser passado. >> @result descri=3DE7=3DE3o do que =3DE9 retornado, no caso de fun=3DE7=3D= F5es. >> *) >> function tantam(par=3DE2metro1, par=3DE2metro2...): algo; >> >> *Conclus=3DE3o* >> =3DE9 preciso ressaltar que apenas os coment=3DE1rios das declara=3DE7= =3DF5es=20 >> con=3D >> tam, o=3D20 >> resto n=3DE3o >> aparece na documenta=3DE7=3DE3o. =3DC9 importante que voc=3DEA v=3DE1=20 >> comentando en=3D >> quanto cria o >> c=3DF3digo, pois depois =3DE9 um saco ter que abrir a unit e ir=20 >> comentando=3D20 >> procedure por procedure! >> Fa=3DE7a coment=3DE1rios objetivos. Lembre-se que um dia pode ser que=20 >> voc=3DEA =3D >> mesmo=3D20 >> acabe tendo >> que ler a documenta=3DE7=3DE3o e com certeza voc=3DEA n=3DE3o vai quer= er ler=20 >> algo=3D >> mal=3D20 >> escrito :) >> >> >> **=3D3D=3D3D=3D3D=3D3D=3D3D >> >> A minha id=3DE9ia =3DE9 distribuir duas vers=3DF5es do Notes SE 2004. = Uma=20 >> ser=3DE1=3D >> o=3D20 >> Notes execut=3DE1vel e outra >> ser=3DE1 o c=3DF3digo fonte. Penso que ambas devem vir com instaladore= s,=20 >> no c=3D >> aso=3D20 >> do fonte para que possamos >> obrigar o cara a concordar com a GPL antes de ter acesso aos fontes.=20 >> Os=3D20 >> que est=3DE3o realmente a fim >> de ajudar-nos v=3DE3o concordar e desta vez ter=3DE3o alguma=20 >> documenta=3DE7=3DE3o=3D >> do=3D20 >> c=3DF3digo a sua disposi=3DE7=3DE3o. >> >> Era wilson! Ab a todos! >> >> --=3D20 >> 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=3DF3rum - http://notes2.sf.net/forum >> >> >> --------------030708010507050300030206 >> Content-Type: text/html; charset=3Dus-ascii >> Content-Transfer-Encoding: 7bit >> >> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> >> <html> >> <head> >> <meta http-equiv=3D"Content-Type"=20 >> content=3D"text/html;charset=3DISO-8859-1"> >> <title></title> >> </head> >> <body text=3D"#000000" bgcolor=3D"#ffffff"> >> <br> >> Olá noteiros de todas as estâncias!<br> >> <br> >> Eis um início de esforço para termos uma=20 >> documentação dos fontes do >> Notes!!!<br> >> <a class=3D"moz-txt-link-freetext"=20 >> href=3D"http://notes2.sourceforge.net/dev/wakka.php?wakka=3DNotesSE200= 4">http://notes2.sourceforge.net/dev/wakka.php?wakka=3DNotesSE2004</a><br= >=20 >> >> <br> >> A partir de agora <b>POR FAVOR, TODOS</b> documentem todo o=20 >> 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=20 >> com os fontes >> do notes atuais<br> >> <a class=3D"moz-txt-link-freetext"=20 >> href=3D"http://notes2.sf.net/srcdocs.zip">http://notes2.sf.net/srcdocs= .zip</a>).=20 >> <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=20 >> funciona, só dá merda).<br> >> <a class=3D"moz-txt-link-freetext"=20 >> href=3D"http://notes2.sf.net/pasdoc.zip">http://notes2.sf.net/pasdoc.z= ip</a><br>=20 >> >> O site do pasdoc é <a class=3D"moz-txt-link-freetext"=20 >> href=3D"http://pasdoc.sourceforge.net">http://pasdoc.sourceforge.net</= a><br>=20 >> >> <br> >> <br> >> <a class=3D"moz-txt-link-freetext"=20 >> href=3D"http://notes2.sourceforge.net/dev/wakka.php?wakka=3DDocumenteO= Codigo">http://notes2.sourceforge.net/dev/wakka.php?wakka=3DDocumenteOCod= igo</a><br>=20 >> >> =3D=3D=3D=3D=3D<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=20 >> usaremos o >> <span class=3D"missingpage">PasDoc</span>, um utilitário<br> >> capaz de usar os comentários do código fonte para criar=20 >> 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=3D"">)<br> >> @author(SegundoAutor <email @do.segundo=3D"">)<br> >> Descrição mais detalhada do que a unit faz, pra que=20 >> serve,etc.<br> >> *)<br> >> unit NomeDaUnit; >> </email></email></tt><br> >> <br> >> <strong>Antes de DECLARAÇÕES de métodos, types,=20 >> constantes, records, >> etc.</strong><br> >> <tt>{descrição do que que o código faz usando um=20 >> 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,=20 >> usando >> comentário simples</tt><br> >> <br> >> <strong>procedures e funções</strong><br> >> No caso de procedures/funções nque não sejam=20 >> óbvias de entender - a >> maioria - você<br> >> deve documentar pra q servem cada um dos parâmetros e o que a=20 >> função >> retorna<br> >> <tt>(**<br> >> @param parâmetro1 descrição do que deve ser=20 >> passado.<br> >> @param parâmetro1 descrição do que deve ser=20 >> passado.<br> >> @result descrição do que é retornado, no caso de=20 >> 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=20 >> declarações contam, o >> resto não<br> >> aparece na documentação. É importante que=20 >> você vá comentando enquanto >> cria o<br> >> código, pois depois é um saco ter que abrir a unit e ir=20 >> comentando >> procedure por procedure!<br> >> Faça comentários objetivos. Lembre-se que um dia pode=20 >> ser que você >> mesmo acabe tendo<br> >> que ler a documentação e com certeza você=20 >> não vai querer ler algo mal >> escrito :)<br> >> <br> >> <br> >> <b></b>=3D=3D=3D=3D=3D<br> >> <br> >> A minha idéia é distribuir duas versões do Notes=20 >> SE 2004. Uma será o >> Notes executável e outra<br> >> será o código fonte. Penso que ambas devem vir com=20 >> instaladores, no >> caso do fonte para que possamos<br> >> obrigar o cara a concordar com a GPL antes de ter acesso aos fontes. O= s >> que estão realmente a fim<br> >> de ajudar-nos vão concordar e desta vez terão alguma=20 >> documentação do >> código a sua disposição.<br> >> <br> >> Era wilson! Ab a todos!<br> >> <pre cols=3D"120" class=3D"moz-signature">-- >> Anderson Rodrigues Barbieri >> -------------------------------------------- >> #Equipe do Notes - Coordenador/Desenvolvedor >> >> { TAndInfo } >> ICQ #149391850 / <a class=3D"moz-txt-link-abbreviated"=20 >> href=3D"mailto:no...@ig...">no...@ig...</a> >> Notes - <a class=3D"moz-txt-link-freetext"=20 >> href=3D"http://notes.codigolivre.org.br">http://notes.codigolivre.org.= br</a>=20 >> >> NotesDev - <a class=3D"moz-txt-link-freetext"=20 >> href=3D"http://notes2.sf.net/dev">http://notes2.sf.net/dev</a> >> Fórum - <a class=3D"moz-txt-link-freetext"=20 >> href=3D"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. =20 > http://messenger.msn.com.br > > > > ------------------------------------------------------- > This SF.net email is sponsored by: SF.net Giveback Program. > Does SourceForge.net help you be more productive? Does it > help you create better code? SHARE THE LOVE, and help us help > YOU! Click Here: http://sourceforge.net/donate/ > _______________________________________________ > notes2-team mailing list > not...@li... > https://lists.sourceforge.net/lists/listinfo/notes2-team > > --=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 |
