16.9 Object documentation, an overview
- Documentation files are rendered from a syntax loosely based on
LaTex.HTML- Plain text
- More on this syntax can be found in the
R extensions manual
roxygen2provides a more user-friendly syntax to create documentation- Comments using
@tags>>man/.Rdfiles >>HTMLor PDFs - Code is intermingled with documentation
- Handles some boilerplate set up
- Abstracts away the differences for documenting different objects
- Manages the
NAMESPACE(Chapter 13)
- Comments using