compare.ignoreComments Parameter

compare.ignoreComments parameter

Use the compare.ignoreComments parameter to set or query whether comments are significant when comparing files with the compare command. When this parameter is in effect, all white space is ignored as well. This parameter is in effect only when certain document parsers are active.

Availability

query command
set command

Scope

compare.ignoreComments is scoped to the current view.
current.compare.ignoreComments is scoped to the current view.
default.compare.ignoreComments is globally scoped.
install.compare.ignoreComments is globally scoped.

Syntax
query compare.ignoreComments
set compare.ignoreComments [default | on | off]
query current.compare.ignoreComments
query default.compare.ignoreComments
set default.compare.ignoreComments [install | on | off]
query install.compare.ignoreComments 
Parameters

default If you specify the default parameter for the set compare.ignoreComments command, the current view will use the value of default.compare.ignoreComments to determine whether the compare command should ignore comments and white space in the document.
on If you specify the on parameter for the set compare.ignoreComments command, the compare command will ignore the presence of comments and white space for the comparison in the current view. If you specify the on parameter for the set default.compare.ignoreComments command, the compare command will ignore the presence of comments and white space for comparisons in any of the document views that have compare.ignoreComments set to default.
off If you specify the off parameter for the set compare.ignoreComments command, the compare command will not ignore the presence of comments for the comparison in the current view. If you specify the off parameter for the set default.compare.ignoreComments command, the compare command will not ignore the presence of comments for comparisons in any of the document views that have compare.ignoreComments set to default.
install If you specify the install parameter for the set default.compare.ignoreComments command, all of the document views that have compare.ignoreComments set to default will use the value of install.compare.ignoreComments to determine whether the compare command should ignore the presence of comments in the document.

Description

The query compare.ignoreComments command returns the comments comparison setting that will be used by the compare command.

If you do not specify any of the parameters for the set compare.ignoreComments command, default is assumed. If you do not specify any of the parameters for the set default.compare.ignoreComments command, install is assumed.

The query current.compare.ignoreComments command returns on if, for the current view, the compare command will ignore comments and white space, and off if, for the current view, the compare command will not ignore comments.

Examples
query compare.ignoreComments
set compare.ignoreComments on
query current.compare.ignoreComments
query default.compare.ignoreComments
set default.compare.ignoreComments off
query install.compare.ignoreComments 
compare command
query command
set command
compare.columns parameter
compare.endColumn parameter
compare.ignoreAllBlanks parameter
compare.ignoreCase parameter
compare.ignoreLeadingBlanks parameter
compare.ignoreSequenceNumbers parameter
compare.ignoreTrailingBlanks parameter
compare.startColumn parameter
current parameter
default parameter
install parameter

default	If you specify the default parameter for the set compare.ignoreComments command, the current view will use the value of default.compare.ignoreComments to determine whether the compare command should ignore comments and white space in the document.
on	If you specify the on parameter for the set compare.ignoreComments command, the compare command will ignore the presence of comments and white space for the comparison in the current view. If you specify the on parameter for the set default.compare.ignoreComments command, the compare command will ignore the presence of comments and white space for comparisons in any of the document views that have compare.ignoreComments set to default.
off	If you specify the off parameter for the set compare.ignoreComments command, the compare command will not ignore the presence of comments for the comparison in the current view. If you specify the off parameter for the set default.compare.ignoreComments command, the compare command will not ignore the presence of comments for comparisons in any of the document views that have compare.ignoreComments set to default.
install	If you specify the install parameter for the set default.compare.ignoreComments command, all of the document views that have compare.ignoreComments set to default will use the value of install.compare.ignoreComments to determine whether the compare command should ignore the presence of comments in the document.