: Re: 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

@Si5022468

As a programmer, you may appreciate that clarity is key in technical documentation. If you write


The password is "X7&t,dH," and should be entered on the login screen.


Readers will expect the password to be exactly what’s encompassed within the quotes, not to have to mentally parse the last character as a punctuation mark to be excluded.

If your code is

var greeting = "hello,"


what would you expect the value of greeting to be? Use the same convention for your comments; the people reading it are the same.

Vote Up Vote Down

0 Reactions   React

Replies (0) Report

Login to post a comment!