comment_example¶

Comment Command Example¶

xrst Comments¶

This sentence has an inline xrst comment . This sentence has a multiple line xrst comment directly after it. The multiple line xrst comment is directly before this sentence.

rst Comments¶

This sentence has a multiple line rst comment directly after it.

The multiple line rst comment is directly before this sentence.

Factorial¶

factorial <- function(n)
{  if( n == 0 )
      return(1)
   else
      return( n * factorial(n-1) )
}

xrst_comment¶

The file below demonstrates the use of xrst_comment .

This Example File¶

# SPDX-License-Identifier: GPL-3.0-or-later
# SPDX-FileCopyrightText: Bradley M. Bell <bradbell@seanet.com>
# SPDX-FileContributor: 2020-22 Bradley M. Bell
# ----------------------------------------------------------------------------
#
# {xrst_begin comment_example}
# {xrst_comment_ch #}
#
# Comment Command Example
# #######################
#
# xrst Comments
# *************
# This sentence has an inline xrst comment {xrst_comment This comment is inline}.
# This sentence has a multiple line xrst comment directly after it.
# {xrst_comment
#     This comment spans multiple lines
# }
# The multiple line xrst comment is directly before this sentence.
#
# rst Comments
# ************
# This sentence has a multiple line rst comment directly after it.
#
# .. comment:
#     This rst comment spans multiple lines
#
# The multiple line rst comment is directly before this sentence.
#
# Factorial
# *********
# {xrst_code r}
factorial <- function(n)
{  if( n == 0 )
      return(1)
   else
      return( n * factorial(n-1) )
}
# {xrst_code}
#
# xrst_comment
# ************
# The file below demonstrates the use of ``xrst_comment`` .
#
# This Example File
# *****************
# {xrst_literal}
#
# {xrst_end comment_example}