Documentação do JS

57 views
Skip to first unread message

Yuri Camara

unread,
Jan 20, 2012, 8:53:12 AM1/20/12
to Javascript Brasil, Javascript-BR, Javascript-bra, Javascript.JS Pro
Bom dia pessoal,

Vcs documentam seus códigos JS? Estou estudando e começando a usar o
JSDoc e estou achando bem interessante. O YUIDoc também parece bom.

Abs!

Thiago Avelino

unread,
Jan 20, 2012, 9:24:02 AM1/20/12
to js...@googlegroups.com, Javascript Brasil, Javascript-BR, Javascript-bra
Geralmente quando mexo com JS é para server-side e escrevo teste unitario, para mim eles server como documentação...

[]'s

--
Thiago Avelino | www.avelino.us
@avelino0



2012/1/20 Yuri Camara <yuric...@gmail.com>

Bruno Henrrique

unread,
Jan 20, 2012, 9:29:42 AM1/20/12
to js...@googlegroups.com, Javascript Brasil, Javascript-BR, Javascript-bra
Acho que os testes são uma ótima forma de documentar...
no client-side vc pode usar Jasmine ....^^

2012/1/20 Thiago Avelino <thiagoav...@gmail.com>



--
Bruno Henrique(Garu)
@garuhenr

Yuri Camara

unread,
Jan 20, 2012, 10:02:23 AM1/20/12
to js...@googlegroups.com, Javascript Brasil, Javascript-BR, Javascript-bra
Este tipo de documentação produzida a partir de comentários no código
como com jsdoc parece pouca falada. Não vi nada a respeito em nenhum
grupo de JS que procurei. Achei estas duas discussões num grupo de
node.js:

https://mail.google.com/mail/#search/jsdoc/1338f0bcee60562f
https://mail.google.com/mail/#search/jsdoc/134a91fc493cd0eb

Bom, eu vou adotar esta prática pelo menos por enquanto. Só queria
trocar ideia com que já faz para saber qual gosta mais e tal.

2012/1/20 Bruno Henrrique <squall...@gmail.com>:

Yuri Camara

unread,
Jan 20, 2012, 10:10:31 AM1/20/12
to js...@googlegroups.com, Javascript Brasil, Javascript-BR, Javascript-bra
Thiago e Bruno,

Quando eu estudar melhor teste unitário eu vejo o esquema da
documentação com ele. Foi bom saber que ele é legal pra fazer tb.

"Só queria trocar ideia com que já faz para saber qual gosta mais e

tal." Troquem o "Só queria" por "Gostaria de". Parece que estou
querendo excluir pessoas do papo, né? rs! Conversa pela net tem essas.

2012/1/20 Yuri Camara <yuric...@gmail.com>:

Bruno Tavares

unread,
Jan 20, 2012, 12:23:40 PM1/20/12
to js.pro
A respeito de documentação de JS, só gostaria de acrescentar o JSDuck:

https://github.com/senchalabs/jsduck

Essa é a engine usada para montar os docs do framework Ext JS e Sencha
Touch.

http://docs.sencha.com/ext-js/4-0/

Não sei direito como ele se aplica para JavaScript puro, ou usando
jQuery e afins, mas vc pode testar.

On Jan 20, 7:10 am, Yuri Camara <yuricam...@gmail.com> wrote:
> Thiago e Bruno,
>
> Quando eu estudar melhor teste unitário eu vejo o esquema da
> documentação com ele. Foi bom saber que ele é legal pra fazer tb.
>
> "Só queria trocar ideia com que já faz para saber qual gosta mais e
> tal." Troquem o "Só queria" por "Gostaria de". Parece que estou
> querendo excluir pessoas do papo, né? rs! Conversa pela net tem essas.
>
> 2012/1/20 Yuri Camara <yuricam...@gmail.com>:
>
>
>
>
>
>
>
> > Este tipo de documentação produzida a partir de comentários no código
> > como com jsdoc parece pouca falada. Não vi nada a respeito em nenhum
> > grupo de JS que procurei. Achei estas duas discussões num grupo de
> > node.js:
>
> >https://mail.google.com/mail/#search/jsdoc/1338f0bcee60562f
> >https://mail.google.com/mail/#search/jsdoc/134a91fc493cd0eb
>
> > Bom, eu vou adotar esta prática pelo menos por enquanto. Só queria
> > trocar ideia com que já faz para saber qual gosta mais e tal.
>
> > 2012/1/20 Bruno Henrrique <squall.br...@gmail.com>:
> >> Acho que os testes são uma ótima forma de documentar...
> >> no client-side vc pode usar Jasmine ....^^
>
> >> 2012/1/20 Thiago Avelino <thiagoavelinos...@gmail.com>
>
> >>> Geralmente quando mexo com JS é para server-side e escrevo teste unitario,
> >>> para mim eles server como documentação...
>
> >>> []'s
>
> >>> --
> >>> Thiago Avelino |www.avelino.us
> >>> @avelino0
>
> >>> 2012/1/20 Yuri Camara <yuricam...@gmail.com>

Yuri Camara

unread,
Jan 20, 2012, 12:56:11 PM1/20/12
to js...@googlegroups.com
Olá Bruno,

Essa eu não tinha visto. Vou dar uma olhada. Valeu!

Não vi nenhuma que pude-se ser aplicado ao jQuery. O JSDoc que foi a
que mais me interessou por enquanto é só pra JS Puro, por exemplo. E
de preferência OO.
Quem quiser saber mais e usar:
http://code.google.com/p/jsdoc-toolkit/
(JSDoc Toolkit é a ferramenta que gera a documentação em HTML usando
como referência os comentários que você fez em seu projeto na sintaxe
JSDoc.)


2012/1/20 Bruno Tavares <brunot...@gmail.com>:

Leonardo Santagada

unread,
Jan 20, 2012, 5:30:06 PM1/20/12
to js...@googlegroups.com
2012/1/20 Yuri Camara <yuric...@gmail.com>:

> Vcs documentam seus códigos JS? Estou estudando e começando a usar o
> JSDoc e estou achando bem interessante. O YUIDoc também parece bom.

o que eu acho mais bonito é o http://jashkenas.github.com/docco/
imagino que deve ter um port para javascript mesmo (talvez até ele
rode com js).

--

Leonardo Santagada

Yuri Camara

unread,
Jan 20, 2012, 7:23:47 PM1/20/12
to js...@googlegroups.com
Tava dando uma olhada neste tb. Suporta Coffescript, Javascript, Ruby e Python.
Vc já chegou a usar?

2012/1/20 Leonardo Santagada <sant...@gmail.com>:

Reply all
Reply to author
Forward
0 new messages