DDoc vs Doxygen (Re: lint for D)

[bearophile]

Nick Sabalausky or Bill Baxter:
> > NaturalDocs is nice (http://www.naturaldocs.org/).  It really does a much 
> > better job of delivering on point 2. above than DDoc does (i.e. using 
> > typical comment style).  Unfortunately it hasn't really caught on. Here 
> > are the examples: http://www.naturaldocs.org/documenting.html.

This is one of the first examples:

/*
   Function: Multiply

   Multiplies two integers.

   Parameters:

      x - The first integer.
      y - The second integer.

   Returns:

      The two integers multiplied together.

   See Also:

      <Divide>
*/
int Multiply (int x, int y)
   {  return x * y;  };

It's nice, but it uses too much vertical space, so the eye loses itself in all that space, and the programs become too much long. To improve readability you should  reduce used space.

The first line: "Function: Multiply" seems redundant (and it's a bad thing) because the true function name and the comments can grow to differ.

Anyway, I don't know if NaturalDocs creators allow D developers to bundle this NaturalDocs into *every* D distribution present and future.

Bye,
bearophile