> > Commenting code out and providing documentation comments are easily
> > done with a good editor, although R documentation comments really belong
> > in files where help() can find them.
>
>   R documentation comments belong in .Rd files at the moment, but how
> joyous would it be if they could be included in the .R files?

This is how I do al my package documentation, using a home-made
comment parser based on javadoc.  It doesn't cover all situations, but
it works well enough for me, and has dramatically increased the
quanity and quality of documentation that I write.

Hadley

______________________________________________
[email protected] mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.

Reply via email to