[DebugInfo][Docs] Improve code formatting in instruction referencing doc

This adds code blocks and inline code formatting to improve the readability of
the instruction referencing doc.

Reviewed By: Orlando

Differential Revision: https://reviews.llvm.org/D126767