add_comments: Add Comments to Character Strings.

In regexr: Readable Regular Expressions

Description

This operator allows you to add comments to character strings.

Usage

x %:)% y

x %comment% y

Arguments

x	A character string that is to be commented.
y	A character string (the comment).

Value

Returns a character string of the class subcom with a comment added as a "comment" attribute.

Note

The operator, %:)%, is a simple smiley face emotion because commented code is happy code.

See Also

comment

Examples

a <- "The character string"
b <- "The comment"

(out <- a %:)% b)
attributes(out)
comment(out)

minimal <- construct("a", "b", "c" %:)% "A love note to your future self")
minimal
comments(minimal)

regexr documentation built on May 29, 2017, 5:57 p.m.