Writing & StyleStyle guide

Formatting Variables in Technical Documentation

Formatting Variables in Technical Documentation records a distinct Microsoft Style Guide authoring convention and keeps it explicitly scoped to technical documentation rather than presenting it as a universal grammar rule.

Quick answer

Usually use code style for variable names in Microsoft-style developer documentation.

Key details

Core IssueMicrosoft developer-content guidance says variables usually use code style.
RegisterMicrosoft technical and professional documentation

Important caveats

Scope Boundary

This page covers programmatic variables; mathematical variables and environment variables have separate documented conventions and should not be collapsed into this rule.

Further guidance

Content

Usually use code style for variable names in Microsoft-style developer documentation.

Purpose

Make literal variable identifiers visually distinct from ordinary explanatory text.

Sources and evidence

Sources are shown with the role they play in this guide. Historical or style-sensitive claims are kept within the evidence boundary described above.

  1. Formatting developer text elements — Microsoft Style Guide (opens in a new tab)Microsoft · Microsoft Style Guide conventions for formatting programmatic and code-related elements in developer content.

Related guides

Writing & Style

Formatting Environment Variables in Technical Documentation

Formatting Environment Variables in Technical Documentation records a distinct Microsoft Style Guide authoring convention and keeps it explicitly scoped to technical documentation rather than presenting it as a universal grammar rule.

Writing & Style

Formatting AI Prompts in Technical Documentation

Formatting AI Prompts in Technical Documentation records a distinct Microsoft Style Guide authoring convention and keeps it explicitly scoped to technical documentation rather than presenting it as a universal grammar rule.

Writing & Style

Formatting Attributes in Technical Documentation

Formatting Attributes in Technical Documentation records a distinct Microsoft Style Guide authoring convention and keeps it explicitly scoped to technical documentation rather than presenting it as a universal grammar rule.

Writing & Style

Formatting Classes in Technical Documentation

Formatting Classes in Technical Documentation records a distinct Microsoft Style Guide authoring convention and keeps it explicitly scoped to technical documentation rather than presenting it as a universal grammar rule.

Writing & Style

Formatting Code Keywords in Technical Documentation

Formatting Code Keywords in Technical Documentation records a distinct Microsoft Style Guide authoring convention and keeps it explicitly scoped to technical documentation rather than presenting it as a universal grammar rule.

Writing & Style

Formatting Code Samples in Technical Documentation

Formatting Code Samples in Technical Documentation records a distinct Microsoft Style Guide authoring convention and keeps it scoped to technical instructions rather than presenting it as a universal grammar rule.

Writing & Style

Formatting Constants in Technical Documentation

Formatting Constants in Technical Documentation records a distinct Microsoft Style Guide authoring convention and keeps it explicitly scoped to technical documentation rather than presenting it as a universal grammar rule.

Writing & Style

Formatting Control Classes in Technical Documentation

Formatting Control Classes in Technical Documentation records a distinct Microsoft Style Guide authoring convention and keeps it explicitly scoped to technical documentation rather than presenting it as a universal grammar rule.

Explore the topic