0

I ask this in the context of comments in computer programming which are written in plain English.

For this question, I require a colon at the end of every comment that is a heading of code. Now, if the heading consists of multiple sentences and I don't want to use a semicolon, is this considered a valid style of punctuation?

# Send e-mail feedback. The user may have opted out:
send()

(An answer will also be useful for running text. I came across this issue multiple times over the years.)

EDIT:

Here's a little clue. However, it contains a semicolon:   [👈👈👈]

Join them; it only takes a minute:
[Join button]

Source: https://linguistics.stackexchange.com/.

closed as primarily opinion-based by Hot Licks, AmE speaker, JJJ, Ellie Kesselman, J. Taylor May 23 '18 at 8:47

Many good questions generate some degree of opinion based on expert experience, but answers to this question will tend to be almost entirely based on opinions, rather than facts, references, or specific expertise. If this question can be reworded to fit the rules in the help center, please edit the question.

  • But is someone going to get on your case for weird punctuation in a source code comment? – Azor Ahai May 2 '18 at 0:11
  • 1
    It's a basic question regarding punctuation in the English language. – h-h May 2 '18 at 0:12
  • 2
    This question belongs on another site in the Stack Exchange network. – Edwin Ashworth May 2 '18 at 0:28
  • 1
    Why? It's about the English language, and an answer applies equally to running text; I just have no example for running text. You can also think of the headings as introducing images, which brings us closer to print media. – h-h May 2 '18 at 0:32
  • "I require a colon at the end of every comment that is a heading of code." If you've got that requirement then it's up to you to come up with a strategy that suits you. This is a question about formatting in a computer program, not a question about the English language. – Hot Licks May 2 '18 at 0:55
-1

Comment by Kris:

A colon at the end of the last sentence is good enough for the entire thing. You could write a paragraph or perhaps, a novel even, and end it in a colon signifying that the whole thing "leads to" what follows. Go ahead and have fun, English grammar or writing style has no problem with it.

Not the answer you're looking for? Browse other questions tagged or ask your own question.