Le 2011/04/20 14:23, Darren New a écrit :
> On 4/20/2011 10:37, Alain wrote:
>> Comments, comments, comments and more comments.
>> That's the only way that code can be used as documentation.
>
> Yep. And that assumes you know the right place to look in the code to
> find the documentation. Without an overview, you wind up guessing which
> source files of which subdirectories you need to read for comments.
>

You start the main with a big comment block that contains an exaustive 
overview of the project. It's then followed by a table of content and an 
index...

Then, each individual source files also contains a specific overview of 
the function(s) of the following code, what kind of data it expect and 
what kind of data it's expected to return. Don't forget the local table 
of content and index.

Post a reply to this message