Brackets

From TechWriter Wiki

Jump to: navigation, search

Avoid the term bracket as it does not indicate the type of bracket to use. Instead, use the relevant specific term as follows:

To refer specifically to one or the other, use the construct (for example) "...opening parenthesis..." and "...closing parenthesis...". Do not use "...left..." and "...right...".

By exception, the term bracket can be used if it specifically refers to any type of bracket. For example, "The parameter must be contained in brackets", where the exact type of bracket used does not matter. (Although even here, it would be better to either mention that any type of bracket can be used, or to list all three types.)

In general writing (prose), parentheses are the preferred method of demarking parenthetical clauses. You would not normally use Square brackets or Braces for parenthetical clauses, unless you had nested parenthetical clauses.

Consider using different types of brackets to convey different types of information. For example, use parentheses (exclusively) to identify parenthetical clauses, but square brackets to denote technical names, or braces to identify variables. Using brackets in a single, consistent way throughout a document (or document set) will aid reader comprehension.

Personal tools
Support