In ordinary text sentences (as opposed to, say, code samples), use code font to mark up most
things that have anything to do with code. In HTML, use the
<code> element; in Markdown, use backticks
Some specific items to put in code font
- Language keywords.
- Class names.
- Method and function names.
- XML and HTML element names. (Also place angle brackets
<>) around the element name; you may have to escape the angle brackets to make them appear in the document.)
- Attribute names and values.
- Filenames and paths.
- Defined (constant) values for an element or attribute.
- Namespace aliases.
- HTTP verbs.
- HTTP status codes.
- HTTP content-type values.
- Query parameter names and values.
- Command-line utility names.
Generally don't put quotation marks around an item that's in code font, unless the quotation marks are part of the item.
Items to put in ordinary (Roman) font
- URLs. (But often it's a good idea to put these on a separate line, enclosed
<pre>, or else to turn them into links. See also the page on link text.)
- Email addresses.
- Headings (including table headings). For clarity, where possible, add a noun to the code-related term in the heading: "Calling the Foo method"; "Setting the Bar parameter".
Other HTML elements for code
Avoid use of the
<xmp> element; it's deprecated
in modern HTML.
<kbd> element to indicate input to be typed (or
otherwise entered) by the user. Use the
<var> element to
indicate any variable (including both specific variable names from code samples
and metasyntactic placeholder variables like foo). Note that you can
use these elements even within a
<pre> block; for
<pre> $ <kbd>ls <var>filename</var></kbd> <var>filename</var> $ </pre>
When you refer to a method name in text, omit the class name except where including it would prevent ambiguity. For example:
Not recommended: To retrieve the zebra's
metadata, call its
Recommended: To retrieve the zebra's
metadata, call its
Put an empty pair of parentheses after a method name to indicate that it's a method.
HTTP status codes
To refer to a single status code, use the following formatting and phrasing:
400 Bad Request status code
In particular, call it a "status code" instead of a "response code," and put the number and the name in code font. If the "HTTP" is implicit from context, you can leave it out.
To refer to a range of codes, use the following form:
400 status code
In particular, use "nxx" (with a specific digit in place of n) to indicate "anything in the n00-n99 range," and put the status code number in code font even if you're leaving out the code's name.
If you prefer to specify an exact range, you can do so:
an HTTP status code in the
Here, too, put the numbers in code font.
Coding style guides
The following Google coding-style guides are available on GitHub:
In general, don't use technical keywords as if they were English verbs or nouns. If in some rare cases you do, then don't try to inflect them.
Recommended: To add the data, send a
Not recommended: Retrieve information by
GETting the data.
Recommended: To retrieve the data, send a
the file requires you to have
open()ed it first.
Recommended: You can't close the file before opening it.
Also recommended: You can't call the
close() method for a file before you call
Exception: When documenting a Java API, it's common to leave out words
like "object" or "instance" and instead just use the class name as a noun: "store
Foo you got from the
FooFactory." If you need to
pluralize such nouns, then add "object" or "instance": "store the
Foo objects you got from the