Yves
(Administrator)
Show profile
Link to this post
Subject: Code reference
Today I have spent some time in the code reference generator I've been thinking about for a while now. It's not finished yet, for example it can only generate a reference on a single page. But it pretty much does what it's supposed to: It gives an overview of all files, constants, functions and classes that appear in the source code along with a description, parameter and return value information and so on.
Of course, you will ask, why I didn't use available systems like Doxygen or PhpDoc. In fact I never worked a lot with those systems, neither in PHP nor other programming languages. But by the time I got used to my own syntax of describing these things and I certainly didn't want to convert them all to some other scheme only because it makes it easier to generate a code documentation. It really wasn't that hard to write that thing and it already helped me improve the code comments for several functions and files.
So here's a first version of that document:
http://newsboard.unclassified.de/code/reference.20051016.h…
More will follow, especially with multiple pages and a more beautiful design. Until then I hope this already helps some of you to better understand the source code.
Of course, you will ask, why I didn't use available systems like Doxygen or PhpDoc. In fact I never worked a lot with those systems, neither in PHP nor other programming languages. But by the time I got used to my own syntax of describing these things and I certainly didn't want to convert them all to some other scheme only because it makes it easier to generate a code documentation. It really wasn't that hard to write that thing and it already helped me improve the code comments for several functions and files.
So here's a first version of that document:
http://newsboard.unclassified.de/code/reference.20051016.h…
More will follow, especially with multiple pages and a more beautiful design. Until then I hope this already helps some of you to better understand the source code.
♪ ...nanananah, all in all we’re just brilliant thieves, nanananah... ♪♬