Skip to main content
Writing

Return to Question

Tweeted twitter.com/StackWriting/status/1267697491341910016
Edited for brevity and clarity
Source Link
rolfedh
rolfedh
  • 1.9k
  • 11
  • 28

Double quotes before period How do I avoid using punctuation inside quotation marks in technical writing?

As a computer programmer, I often write something similar to the following (forcomment my code comments). For example:

The following lines are dependent on "source 1" and "source 2". "Source 2" is a user login and password. Overall, the purpose is to retrieve an AWS token The ajax call to an AWS Gateway requires a token.

I double quote source 1 and source 2 so as to make clear (or perhaps emphasize) that "source 1" and "source 2" representto make it clear they are entities.

Should I use double quotes or should I use something else (e.g. italics or bold)? And if double quotes is appropriate, should I put the period before the double quote of source 2 (i.e. "source 2." instead of "source 2".)?

  • Should I use double quotes or something else, such as italics or bold?
  • For double-quotes, should I put the period inside or outside the closing quotation mark?

Double quotes before period

As a computer programmer, I often write something similar to the following (for code comments):

The following lines are dependent on "source 1" and "source 2". "Source 2" is user login and password. Overall, the purpose is to retrieve an AWS token The ajax call to an AWS Gateway requires a token.

I double quote source 1 and source 2 so as to make clear (or perhaps emphasize) that "source 1" and "source 2" represent entities.

Should I use double quotes or should I use something else (e.g. italics or bold)? And if double quotes is appropriate, should I put the period before the double quote of source 2 (i.e. "source 2." instead of "source 2".)?

How do I avoid using punctuation inside quotation marks in technical writing?

As a computer programmer, I comment my code. For example:

The following lines are dependent on "source 1" and "source 2". "Source 2" is a user login and password. Overall, the purpose is to retrieve an AWS token The ajax call to an AWS Gateway requires a token.

I double quote "source 1" and "source 2" to make it clear they are entities.

  • Should I use double quotes or something else, such as italics or bold?
  • For double-quotes, should I put the period inside or outside the closing quotation mark?
Corrected formatting
Source Link
Chenmunka
Chenmunka
  • 1.3k
  • 4
  • 21
  • 34

As a computer programmer, I often write something similar to the following (for code comments):

As a computer programmer, I often write something similar to the following (for code comments):

The following lines are dependent on "source 1" and "source 2". "Source 2" is user login and password. Overall, the purpose is to retrieve an AWS token The ajax call to an AWS Gateway requires a token.

The following lines are dependent on "source 1" and "source 2". "Source 2" is user login and password. Overall, the purpose is to retrieve an AWS token The ajax call to an AWS Gateway requires a token.

I double quote source 1 and source 2 so as to make clear (or perhaps emphasize) that "source 1" and "source 2" represent entities.

Should I use double quotes or should I use something else (e.g. italics or bold)? And if double quotes is appropriate, should I put the period before the double quote of source 2 (i.e. "source 2." instead of "source 2".)?

As a computer programmer, I often write something similar to the following (for code comments):

The following lines are dependent on "source 1" and "source 2". "Source 2" is user login and password. Overall, the purpose is to retrieve an AWS token The ajax call to an AWS Gateway requires a token.

I double quote source 1 and source 2 so as to make clear (or perhaps emphasize) that "source 1" and "source 2" represent entities.

Should I use double quotes or should I use something else (e.g. italics or bold)? And if double quotes is appropriate, should I put the period before the double quote of source 2 (i.e. "source 2." instead of "source 2".)?

As a computer programmer, I often write something similar to the following (for code comments):

The following lines are dependent on "source 1" and "source 2". "Source 2" is user login and password. Overall, the purpose is to retrieve an AWS token The ajax call to an AWS Gateway requires a token.

I double quote source 1 and source 2 so as to make clear (or perhaps emphasize) that "source 1" and "source 2" represent entities.

Should I use double quotes or should I use something else (e.g. italics or bold)? And if double quotes is appropriate, should I put the period before the double quote of source 2 (i.e. "source 2." instead of "source 2".)?

Source Link
J.J.
J.J.
  • 31
  • 2

Double quotes before period

As a computer programmer, I often write something similar to the following (for code comments):

The following lines are dependent on "source 1" and "source 2". "Source 2" is user login and password. Overall, the purpose is to retrieve an AWS token The ajax call to an AWS Gateway requires a token.

I double quote source 1 and source 2 so as to make clear (or perhaps emphasize) that "source 1" and "source 2" represent entities.

Should I use double quotes or should I use something else (e.g. italics or bold)? And if double quotes is appropriate, should I put the period before the double quote of source 2 (i.e. "source 2." instead of "source 2".)?