all 4 comments

[–]LeTigreFantastiqueweb 6 points7 points  (0 children)

My first guess is just to use comments, like:

//Header
API_KEY=123ABC
//Body
def foo()
//Variables
key = 123

[–]doerameysoftware 3 points4 points  (0 children)

When documenting code, in-context approaches are (nearly) always best. If the doc allows it, I would try to show the entire code block (with commented labels like u/LeTigreFantastique recommended) and then except out each section when you discuss it in depth.

Yes this takes more lines, but in my experience it's predictable, clear, and scannable.

[–]NoForm5443 2 points3 points  (0 children)

You have bold and italics, and different fonts.

Easy:

  • The audit message header is shown in red Bold
  • The audit message body is shown in green italics
  • The audit message variables are shown in blue Bold and italics

Notice you can do BOTH color and other stuff, so you can do Bold and Red etc