Share via

<comment> Element

  • Article

Marks text in a script component file that should be ignored.

<comment>
   text here
</comment>

Remarks

Use the <comment> element inside other XML elements to enclose text that is not markup and not data, but that you want to include for other purposes, such as documentation.

Example

The following script component fragment shows a <comment> element inside a <public> element.

<public>
   <comment>
      This implements an Automation component with the 
      method "random" and the property "uppercaseName"
   </comment>
   <method name="random" internalName="getRandomNumber"/>
   <property name="uppercaseName">
      <get internalName="get_ucname"/>
      <put internalName="put_ucname"/>
   </property>
</public>

See Also

Concepts

Script Component File Contents