[thelist] Good documentation guides?

Diego webmaster at sci-web.com.ar
Thu Oct 31 18:27:01 CST 2002


I'm not sure I did understand you right, but here goes a link for PHPDoc, a
documentation set based apparently on the one that java programmers use:

http://www.devshed.com/Server_Side/PHP/SelfDoc/page1.html

I think this documentation is created from parsed comments in scripts,
comments that should follow some predefined format. By the way, javascript
is lacking some sort of this, if i'm wrong please anyone tell me, since I
would like to write some sort of 'near standard' or kind of or almost of a
kind (please forgive me any bad english) documentation for dhtml scripts. If
someone is interested in this please write to me..., I would like to dig
into this, since i do not find it fantastic, dhtml is very hard to mantain.

regards
Diego (sci_FI)
http://sci-web.com.ar


----- Original Message -----
From: "Rachel Cunliffe" <rachel at cre8d-design.com>
To: <thelist at lists.evolt.org>
Sent: Thursday, October 31, 2002 9:20 PM
Subject: [thelist] Good documentation guides?


> Hi everyone
>
> I'm looking around for good documentation practices/guides/standards for
> documenting coding projects?
>
> This will be written up in LaTeX (or docBook) so I'm more interested in
the
> guides to writing good content, rather than good formats.
>
> Does anyone have any suggestions?
>
> Many thanks,
> Rachel
>
> --
> For unsubscribe and other options, including
> the Tip Harvester and archive of thelist go to:
> http://lists.evolt.org Workers of the Web, evolt !
>




More information about the thelist mailing list