How should inline source text be written?

We're pretty consistent about writing block examples as 21.3 Code Listings:

<pre><code class="javascript">
  let str = "1 + 1;";
  eval(str);
  eval(str);
</code></pre>

But as far as I can tell, there's no preferred form for inline code. Many sites use `…` (as seen in e.g. Source Text Module Records and ExportEntry Record Fields), but that doesn't seem right to me. Many other sites use <code>…</code> (e.g., implementation-approximated), which seems better. But <code>…</code> is also used for references to external files/symbols/etc. (as in e.g. String.prototype.toLowerCase ( ), ShallowestContainedJSONValue, and Shared Memory Guidelines), and it would be nice to distinguish those uses.

I think something like <code class="javascript">…</code> would be ideal, even if the class has no effect on rendering.

As discussed in today's editor call, we'd like to separate some cases:

For referring to built-in values/keywords/etc. as seen in e.g. implementation-approximated and ShallowestContainedJSONValue, use `…` and prefer wrapping in <emu-xref>.
For inline examples of ECMAScript source text as seen in e.g. Source Text Module Records, use <code class="javascript">…</code> such that a future change can add syntax highlighting.
For references to external files/symbols/etc. as seen in e.g. String.prototype.toLowerCase, ShallowestContainedJSONValue, and Shared Memory Guidelines, use <code>…</code>.

Navigation Menu