However, I was recently told to not use code blocks for this purpose.
I'm guessing that was me. Here's the full-text I normally use when I comment on this use of the code markup:
Please do not use backquotes to highlight quoted text in comments. This syntax should be reserved for code or data, not normal text. Abusing code markdown causes problems for parsing tools such as screen readers for the visually impaired and is easily avoided by using italics and quotation marks instead.
(Short form) Please avoid using code markup to format quotes. You can use italics and quotation marks instead.
There are several reasons not to abuse this syntax:
- it's unnecessary: you have a choice of quotation marks and/or italic syntax (
*text*
) at your disposal to identify quotes - it's ugly: code markup uses a distinct monospaced font that breaks the flow of what is supposed to be regular text
- it's not what they're for: code markup has a distinct meaning and this is contrary to the site's visual identity
- it screws people using screen readers and other alternative methods to consume the page (see the Arqade link for details)
- it adds unexpected emphasis: this is a problem both if it's done deliberately or if it's unintended as it seems to put focus on a quoted section that's, by definition, only a reference and not the author's main statement
Note that this applies across the entire network. Sites that don't have a need for code markup simply shouldn't use it!
For more details why abuse of code markup is problematic:
Meta: Inline Code Spans should not be used for emphasis, right?Inline Code Spans should not be used for emphasis, right?
Arqade: Using code ticks for technical term highlighting considered harmful
Note that actual quote markup for comments has been a feature request for nearly 5 years nowhas been a feature request for nearly 5 years now.