0

I am writing a thesis about a web application that I developed. I sometimes need to reference a variable or type from the code. This happens quite a lot in the maintenance guide that I am also writing. They appear in the middle of the text so creating a code block for them is no option.

Does anyone know the proper way to mark them? I came up with these ideas:

  1. The "greenhouseData" needs to....
  2. The greenhouseData needs to....
  3. The <greenhouseData> needs to....
Improve this question
1
  • 1
    Every editor/school/office etc. will have their own ideas. For "mechanical" style issues such as this you should look for style guidance from the place your document will get published. A thesis for example should check with the department/school. Check how others have done it. Check for official style guidance from the school. But I did give thumbs up to mh333's answer.
    – Boba Fit
    Commented Jan 13, 2023 at 13:24

1 Answer 1

Reset to default
2

Commonly this is done by using a monospaced font - often the same font as used in your code blocks.

Example: The greenhouseData needs to....

See also here: What are the conventions for indicating programming variables within text? and maybe also Proper way to format computer code included in a thesis/dissertation

Improve this answer

Not the answer you're looking for? Browse other questions tagged .