The following table shows the typographic conventions that are used in Microsoft® SDK for Java.
Example | Convention |
public boolean equals(Object objOther); | Bold font indicates method names in syntax. |
clipping
zCmpCaps D3DBLEND_ONE |
Bold font indicates field names. They can be lowercase, concatenated with internal capitals, or all uppercase. |
setup | Bold font indicates words, other than language commands, that you must type. |
On the File menu, choose Open. | Bold font is used in procedures to highlight interface elements such as the name of a window, menu, dialog box, toolbar, button, or option. |
HRESULT | Bold font is used for this COM return type. |
/base: | Bold font is used for command-line options. |
Control | "Control" in bold font indicates a Java class that has been registered as a COM object, implying that the object is a Microsoft® ActiveX® Control. |
cannot | Bold font is used for emphasis in important statements. |
C:\%Windir%\System[32] | Bold font and initial capital letters identify folders and directories, and file names are separated by backslashes (\). |
Example.cab | Initial capital letters indicate file names. |
ComExeception readLicense IPermission |
Initial capital letters indicate the names of classes, interfaces, and methods. However, some methods have initial lowercase letters. If the name consists of more than one word, the initial letter of each word is capitalized and the group of words are concatenated. |
http://www.microsoft.com/ | Lowercase letters are used for URLs. Server, share, and file names are separated by forward slashes (/).(Example not an active link.) |
hr | Italicized letters or words indicate parameters. |
<file name> | Italicized words enclosed in angle brackets (in examples and syntax) indicate placeholders for information you supply. |
@commandfile | Italicized words indicate command-line arguments. |
The Java Virtual Machine Specification | Italicized words indicate titles of publications. |
thread | Single-underlined words or phrases denote Glossary terms. Click the term to see its definition. (Example not an active link.) |
myMethod | Single-underlined words, concatenated words, or phrases indicate links either inside or outside the SDK for Java. (Example not an active link.) |
[!] | For tools, square brackets indicate options on the command line. For example, /bx [!]. Information in square brackets is not required. |
| | For tools and attributes, a bar indicates a choice. For example, /bx [x|-]. Although a choice is given, information on either side of the bar is not required. |
public static int cbByValSize; |
Monospace font in a gray background indicates members of classes and interfaces; is also for example and sample code. |