Verified documentation comments
Rob T
rob at ucora.com
Sat Nov 17 08:44:38 PST 2012
On Thursday, 15 November 2012 at 18:45:58 UTC, bearophile wrote:
>
> Currently in D if you have a documentation comment like this it
> generates no warnings or notes:
>
> /**
> * Params:
> * x = is for this
> * and not for that
> * x = is for this
> * and not for that
> * y = is for that
> *
> * Returns: The contents of the file.
> */
> void foo(int x) {}
>
> void main() {}
>
>
> Bye,
> bearophile
Another improvement would be place holders for the parameters
that get filled in automatically. It's extremely tedious,
redundant, and error prone to manually name parameters inside the
document comments.
I like the idea of embedded documentation, it's nice and has a
ton of potential, and can be made a whole lot better.
--rt
More information about the Digitalmars-d
mailing list