Skip to content

Meta-Data Tag Format and Rules

Format

There are three elements to a meta-data declaration:

  1. The meta-data tag set declaration.
  2. A description of the code constructs being declared (optional).
  3. The actual code construct declaration (e.g., a class, method, or property declaration, etc.).

Meta-Data Tag Syntax

Meta-data tags are defined inside curly braces {} using name=value pairs. The meta-data tag set syntax will take the following general format:

{ name=value name="value" name="value1, value2, value3" }

-or-

{ name=value }
{ name="value" }
{ name="value1, value2, value3" }

-or-

{
    name=value   // Comments are supported at the end of each line
    name="value"
    name="value1, value2, value3"
}

Rules

  • 'Name' must belong to one of the public tag name values in the tables listed in Class Meta-Data Tags or Class Member Meta-Data Tags. An undefined name is considered to be an error.
  • 'Value' can be any string of alphanumeric characters.
  • If the value contains whitespace, quote characters, a comma, or } characters, then it must be enclosed in single or double quotes.
  • Multiple values for a single name can be defined as a comma-separated list.
  • Multiple tag sets (e.g., { … }) may be defined for a single code construct.
  • The tag list can be defined over several contiguous lines.
  • The name=value pairs are separated from each other using a whitespace character or a new line.
  • Each individual name=value must start and end on the same line.
  • The order of meta-data tags is not significant, except when explicitly stated.
  • The meta-data tag set must be declared physically above the code construct being described.
  • Only blank lines and the description can appear between the meta-data tag set and the code construct being declared.
  • Whitespace can be used to separate the name=value (e.g., name = value).
  • Meta-data tags are not case sensitive.
  • A meta-data tag set must appear on its own line; i.e., it cannot be mixed with other DataFlex commands on the same line.

See Also