PDA

View Full Version : standard JavaDoc for Delphi


{MSX}
19-01-2005, 09:48 AM
Hi! I hope all of you knows what javadocs are :P
I was wondering if is there a standar "delphidoc" system.. i've seen some around but they was all "private" things.. is there a standard one ?
I'd like to comment/doc my programs..

JavaDoc rules!
savage
19-01-2005, 10:08 AM
You could try something like this...
http://www.hoyld.freeserve.co.uk/code/pascaldoc.html

Though I have not used it, so it would be interesting to here any reviews on it.
{MSX}
19-01-2005, 10:18 AM
Umm maybe that could work.. but hasn't Delphi2005 a standard way of documenting code ?
Sly
19-01-2005, 11:11 AM
From my use of Delphi 2005 so far, I have not seen any 'standard' way of documenting code. But then, I have not tried all of the new features yet.

You could also try PasDoc (http://pasdoc.sourceforge.net/phpwiki/).
cairnswm
19-01-2005, 11:41 AM
Thanks for the link to 'pascal doc' I think it has real potention. I see it hasn't been updated in 2 years so I made some changes for myself. (I've added menus from the explorer window to add comments intot he file).

Its nice in that it does add JavaDoc style comments intot he code for you as well as having a reporting feature to extract these comments into a document for you.

S2DL ver 1.04 will come out with some documentation now.
{MSX}
19-01-2005, 01:00 PM
[quote="cairnswm"]Thanks for the ]

I don't know.. but the program is 2 year old and is probably not mantined anymore..
We could ask FPK if there is an official freepascal choose among various system
{MSX}
19-01-2005, 08:19 PM
I've talked with fpk and he suggested to use PasDoc for source documentation.
So we all can now fill our code with documentation (who believe this? :P )
{MSX}
19-01-2005, 09:21 PM
I've tried out PasDoc and even if it's a little raw i was quite satisfacted.
I've lunched it for FunkyCars project, ad it generated the "skeleton" in a right way. (obviously there is no "documentation" in there, only the structure.. i've still to write it :P )
You can see the results here:

http://funkycars.sf.net/pasdoc/

What do you think about ?
savage
20-01-2005, 06:24 AM
Looks like a good start. I wonder if it is worth running it over the JEDI-SDL sources.
{MSX}
20-01-2005, 07:49 AM
Looks like a good start. I wonder if it is worth running it over the JEDI-SDL sources.

I think it's worth. Even if it's not commented, it is good to have such a nice "summary".

here's the command i used:



/home/nicola/pasdoc/PasDoc-0.8.8/source/console/PasDoc_Console
--staronly -E docs/pasdoc/ src/game/*.pas src/generic/*.pas
src/odeutils/*.pas