Wrox Home  
Search P2P Archive for: Go

  Return to Index  

javascript_howto thread: A good idea: "javascriptDoc"...


Message #1 by "Sten Hougaard" <STG@e...> on Mon, 13 Jan 2003 10:04:12 +0100
Hi,

Just got an Idea: a program - javascriptDoc. You may have heard of Java
Doc
for Java,
a very handy utility which automatically can create documentation of ja
va
files.

The things that such a "javascriptDoc" utility would offer would be:
- Generate HTML files as JavaDoc does
- Files containing standard documenation for functions and vars,
  for instance which parameters need to be passed to a function,
  and perhaps the util could try to guess which "type" the vars sould b
e.
  If for instance the user have "var myString =3D 'test'", in this exam
ple
the
  program could "guess" that it should be a string because of the
assignment
  containing single-quotes.
  Another argument could be that people could start to do more nice-loo
king
  and well-formatted javascript (so that the util could do auto
documentation for
  them :-).

What do you all think? Is this a good idea or ?

Cheers,

Sten Hougaard
EDB Gruppen
ASPECT/4 e-novation
=C5rhus - Denmark
www.edbgruppen.dk




  Return to Index