OOF2: The Manual
Name
OOF.Settings.Output_Formatting.Comment_Character — Set the string used to mark comments in output files.
Synopsis
OOF.Settings.Output_Formatting.Comment_Character(comment_character
)
Details
- Parent Menu: OOF.Settings.Output_Formatting
-
Callback: function
_dummy
in moduleooflib.common.IO.formatchars
-
Parameters:
comment_character
- The string used to mark comments in output files. Type: A character string.
Description
The comment character is printed at the beginning of header lines in
data files written by Analyses and Scheduled
Outputs. The header lines identify the source of the data
and the contents of each column. If you're going to be loading the
data file into a plotting program, set the
comment_character
to whatever is appropriate for
that program, to ensure that it doesn't interpret the header as
data.
The comment_character
is actually a character
string and can contain more than one character.