vs vs for inline and block code snippets

by

Use <code> for inline code that can wrap and <pre><code> for block code that must not wrap. <samp> is for sample output, so I would avoid using it to represent sample code (which the reader is to input). This is what Stack Overflow does.

(Better yet, if you want easy to maintain, let the users edit the articles as Markdown, then they don’t have to remember to use <pre><code>.)

HTML5 agrees with this in “the pre element”:

The pre element represents a block of preformatted text, in which structure is represented by typographic conventions rather than by elements.

Some examples of cases where the pre element could be used:

  • Including fragments of computer code, with structure indicated according to the conventions of that language.

[…]

To represent a block of computer code, the pre element can be used with a code element; to represent a block of computer output the pre element can be used with a samp element. Similarly, the kbd element can be used within a pre element to indicate text that the user is to enter.

In the following snippet, a sample of computer code is presented.

<p>This is the <code>Panel</code> constructor:</p>
<pre><code>function Panel(element, canClose, closeHandler) {
      this.element = element;
      this.canClose = canClose;
      this.closeHandler = function () { if (closeHandler) closeHandler() };
    }</code></pre>

More Related Contents:

  1. Should I use tag for icons instead of ? [closed]
  2. input type=”submit” Vs button tag are they interchangeable? [duplicate]
  3. Is a DIV inside a TD a bad idea?
  4. Using custom HTML Tags
  5. Should a heading be inside or outside a ?
  6. Are block-level elements allowed inside inline-level elements in HTML5?
  7. HTML5 nested sections and heading tags
  8. Markup for postal addresses
  9. w3c html validation error – Section lacks heading. Consider using h2-h6 elements to add identifying headings to all sections
  10. Valid to use (anchor tag) without href attribute? [duplicate]
  11. How to properly use h1 in HTML5
  12. When to use line breaks vs CSS positioning?
  13. Marking up a search result list with HTML5 semantics
  14. CSS/HTML: What is the correct way to make text italic?
  15. Is it correct to use DIV inside FORM?
  16. Most common way of writing a HTML table with vertical headers?
  17. Make column bigger – CSS code [closed]
  18. How to center a flex container but left-align flex items
  19. Two inline-block elements, each 50% wide, do not fit side by side in a single row
  20. Tables instead of DIVs [duplicate]
  21. Is type=”text/css” necessary in a tag?
  22. Text overflow ellipsis on two lines
  23. How can I make a link from a table cell
  24. How can I generate an HTML report for Junit results?
  25. How can I make a TextArea 100% width without overflowing when padding is present in CSS?
  26. How to link html pages in same or different folders?
  27. How can I make a 45 degree responsive ribbon with folded corner?
  28. Is text-indent: -9999px a bad technique for replacing text with images, and what are the alternatives?
  29. HTML5 flexible box model height calculation
  30. How do I pretty-print HTML with Nokogiri?

Leave a Comment