Writing & StyleStyle guide

Not Applying Code Style to Linked Reference Text

Not Applying Code Style to Linked Reference Text records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal grammar rule.

Quick answer

When a program element is linked to reference documentation, do not also apply code formatting to the link text because code styling can obscure that it is a link.

Key details

Core Issuecode style on linked reference documentation
RegisterMicrosoft Learn technical documentation

Important caveats

Scope Boundary

This is Microsoft Learn contributor guidance for linked program-element references; subsequent unlinked mentions can still use code style where appropriate.

Further guidance

Content

When a program element is linked to reference documentation, do not also apply code formatting to the link text because code styling can obscure that it is a link.

Purpose

Keep technical documentation readable, reusable, and unambiguous for readers while following current Microsoft Learn contributor conventions.

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. How to include code in docs — Microsoft Learn Contributor Guide (opens in a new tab)Microsoft · Current Microsoft Learn contributor guidance on including code in documentation, including link/code styling, code-block quality checks, screenshots, validation, highlighting, scrollability, bad-code labeling, and in-repository snippet references.

Related guides

Writing & Style

Using Custom Link Text With Markdown-Style XRefs

Using Custom Link Text With Markdown-Style XRefs records a distinct Microsoft Learn XRef authoring decision and consolidates tightly coupled syntax choices so the public guide stays useful without fragmenting one task into thin pages.

Writing & Style

Using Reference-Style Links in Microsoft Learn

Using Reference-Style Links in Microsoft Learn records a distinct Microsoft Learn authoring convention and keeps it scoped to that documentation environment rather than presenting it as a universal writing rule.

Explore the topic