Typographical Conventions

Typographical conventions are used in our code examples. Learn what Courier font, italics, and brackets mean.

Courier font

In descriptions of syntax, a monospace font indicates items that you should type as shown, except for brackets. For example:

1Public class HelloWorld

In descriptions of syntax, italics represent variables. You supply the actual value. In the following example, three values must be supplied: datatype__variable_name [ = value];

If the syntax is bold and italic, the text represents a code element that needs a value supplied by you, such as a class name or variable value:

1public static class YOURCLASSHERE { ... }

Bold courier font

In code samples and syntax descriptions, a bold courier font emphasizes a portion of the code or syntax.

< > (less-than and greater-than symbols)

In descriptions of syntax, less-than and greater-than symbols (< >) are typed exactly as shown.

1<apex:pageBlockTable value="{!account.Contacts}" var="contact">
2   <apex:column value="{!contact.Name}"/>
3   <apex:column value="{!contact.MailingCity}"/>
4   <apex:column value="{!contact.Phone}"/>
5</apex:pageBlockTable>

{ } (braces)

In descriptions of syntax, braces ({ }) are typed exactly as shown.

1<apex:page>
2    Hello {!$User.FirstName}!
3</apex:page>

[ ] (brackets)

In descriptions of syntax, anything included in brackets is optional. In the following example, specifying {value} is optional:

1DATA_TYPE VARIABLE_NAME [ = VALUE];

| (pipe)

In descriptions of syntax, the pipe sign means “or”. You can do one of the following (not all). In the following example, you can create a new unpopulated set in one of two ways, or you can populate the set:

1Set<DATA_TYPE> SET_NAME
2   [= new Set<DATA_TYPE>();] |
3   [= new Set<DATA_TYPE{VALUE [, VALUE2. . .] };] |
4   ;