Use Correct Grammar [DW1]

Use Correct Grammar [DW1]

Tip DW1

Use correct grammar for the human language in which you are writing comments. Incorrect grammar can be distracting and harder to read as it deviates from the normal expectations of most people.

Correct grammar includes:

  • Capitalization

    • In English, the first letter of a sentence or proper noun should be capitalized.

  • Spelling

    • Make sure words are correctly spelled to prevent confusion (potentially with other similar words).

  • Spacing

    • In English, 1 space between words and 1-2 spaces between sentences is standard.

  • Punctuation

    • In English, end sentences (or sentence-like comments) with punctuation to make sure the ending of a comment is clear, rather than leaving a reader wondering if a comment was finished or not.

  • Sentence structure

    • Make sure sentence structure conventions are followed for your language. Deviating could make it hard for someone else to understand what you’re writing (and switching word orders could make a comment mean something different).

Tap into your teams collective wisdom ad.png

The following example shows a contrast between a comment with poor grammar and a comment with proper grammar: