1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
%
% SmartComments.R
%
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\name{SmartComments}
\docType{class}
\alias{SmartComments}
\title{Abstract class SmartComments}
\description{
Package: R.utils \cr
\bold{Class SmartComments}\cr
\code{\link[R.oo]{Object}}\cr
\code{~~|}\cr
\code{~~+--}\emph{\code{SmartComments}}\cr
\bold{Directly known subclasses:}\cr
\link[R.utils]{LComments}, \link[R.utils]{VComments}\cr
public abstract static class \bold{SmartComments}\cr
extends \link[R.oo]{Object}\cr
Abstract class SmartComments.
}
\usage{
SmartComments(letter=NA, ...)
}
\arguments{
\item{letter}{A single \code{\link[base]{character}}.}
\item{...}{Not used.}
}
\section{Fields and Methods}{
\bold{Methods:}\cr
\tabular{rll}{
\tab \code{\link[R.utils:compile.SmartComments]{compile}} \tab Preprocess a vector of code lines.\cr
\tab \code{\link[R.utils:convertComment.SmartComments]{convertComment}} \tab Converts a single smart comment to R code.\cr
\tab \code{\link[R.utils:parse.SmartComments]{parse}} \tab Parses one single smart comment.\cr
\tab \code{\link[R.utils:reset.SmartComments]{reset}} \tab Resets a SmartComments compiler.\cr
\tab \code{\link[R.utils:validate.SmartComments]{validate}} \tab Validates the compiled lines.\cr
}
\bold{Methods inherited from Object}:\cr
$, $<-, [[, [[<-, as.character, attach, attachLocally, clearCache, clearLookupCache, clone, detach, equals, extend, finalize, getEnvironment, getFieldModifier, getFieldModifiers, getFields, getInstantiationTime, getStaticInstance, hasField, hashCode, ll, load, names, objectSize, print, save
}
\details{
A "smart" source-code comment is an \R comment, which start with a '#',
but is followed by a single letter, then a single symbol and a second
'#' and then an option character string, and there must not be any code
before the comment on the same line. In summary, a smart comment line
has format: \code{<white spaces>#<letter><symbol># <some text>}.
Example code with two smart comments (VComments):
\preformatted{
x <- 2
#V1# threshold=-1
#Vc# A v-comment log message
cat("Hello world")
}
which after compilation becomes
\preformatted{
x <- 2
verbose <- Verbose(threshold=-1)
if (verbose) { cat(verbose, "A v-comment log message"); }
cat("Hello world")
}
}
\author{Henrik Bengtsson}
\seealso{
\code{\link{VComments}}.
}
\keyword{classes}
\keyword{programming}
\keyword{IO}
|
