[MIRLangRef] Document MachineOperand comments

[SjoerdMeijer]

Summary

Late follow-up of D74306 to document MachineOperand comments in MIRLangRef.

[dmgreen]

Sounds good to me.

(Although, I would move it out from the middle of the "Operands" section. Maybe to after Predicate Operands, so it's still in "Machine Operands" but not between two other Operand types)

[SjoerdMeijer]

Thanks Dave, I will move it before committing.

llvm/docs/MIRLangRef.rst

.. code-block:: text
     %1:gpr64 = SUBREG_TO_REG 0, %0, %subreg.sub_32
 
 For integers > 64bit, we use a special machine operand, ``MO_CImmediate``,
 which stores the immediate in a ``ConstantInt`` using an ``APInt`` (LLVM's
 arbitrary precision integers).
 
 .. TODO: Describe the FPIMM immediate operands.
 
+Comments
+^^^^^^^^
+
+Machine operands can have C/C++ style comments, which are annotations enclosed
+between ``/*`` and ``*/`` to improve readability of e.g. immediate operands.
+In the example below, ARM instructions EOR and BCC and immediate operands
+``14`` and ``0`` have been annotated with their condition codes (CC)
+definitions, i.e. the ``always`` and ``eq`` condition codes:
+
+.. code-block:: text
+
+  dead renamable $r2, $cpsr = tEOR killed renamable $r2, renamable $r1, 14 /* CC::always */, $noreg
+  t2Bcc %bb.4, 0 /* CC:eq */, killed $cpsr
+
+As these annotations are comments, they are ignored by the MI parser.
+Comments can be added or customized by overriding InstrInfo's hook
+``createMIROperandComment()``.
+
 .. _register-operands:
 
 Register Operands
 ^^^^^^^^^^^^^^^^^
 
 The :ref:`register <registers>` primitive is used to represent the register
 machine operands. The register operands can also have optional
 :ref:`register flags <register-flags>`,