Back to Freecodecamp

Task 32

curriculum/challenges/english/blocks/learn-how-to-document-code-for-a-project/65e9393152c63010e8d14dce.md

latest1.8 KB
Original Source
<!-- (Audio) Brian: Try to ensure that your comments are clear and concise. -->

--description--

Ensure means to make certain that something happens or is the case. For example, Ensure the door is locked before leaving.

Clear means easy to understand, like a clear explanation.

Concise means expressing something in a few words without unnecessary detail. An example is, She gave a concise summary of the report.

--fillInTheBlank--

--sentence--

Try to BLANK that your comments are BLANK and BLANK.

--blanks--

ensure

--feedback--

It is about making sure something is done correctly or happens in a certain way. Brian is emphasizing making sure the comments are well-written.


clear

--feedback--

This word in this context means easy to understand. Brian advises that the comments should be straightforward and easy to grasp.


concise

--feedback--

This word means brief and to the point. Brian is suggesting that the comments should be short and not overly detailed.

--scene--

json
{
  "setup": {
    "background": "company2-center.png",
    "characters": [
      {
        "character": "Brian",
        "position": {
          "x": 50,
          "y": 15,
          "z": 1.2
        },
        "opacity": 0
      }
    ],
    "audio": {
      "filename": "7.1-2.mp3",
      "startTime": 1,
      "startTimestamp": 30.36,
      "finishTimestamp": 33.82
    }
  },
  "commands": [
    {
      "character": "Brian",
      "opacity": 1,
      "startTime": 0
    },
    {
      "character": "Brian",
      "startTime": 1,
      "finishTime": 4.46,
      "dialogue": {
        "text": "Try to ensure that your comments are clear and concise.",
        "align": "center"
      }
    },
    {
      "character": "Brian",
      "opacity": 0,
      "startTime": 4.96
    }
  ]
}