Back to Freecodecamp

Dialogue 3: Analyzing Code Documentation for Classes and Objects

curriculum/challenges/english/blocks/learn-how-to-analyze-code-documentation/660694cf7803c598ce999171.md

latest2.9 KB
Original Source

--description--

Watch the video to understand the context of the upcoming lessons.

--assignment--

Watch the video

--scene--

json
{
  "setup": {
    "background": "company2-center.png",
    "characters": [
      {
        "character": "Sophie",
        "position": { "x": -25, "y": 0, "z": 1 }
      },
      {
        "character": "Brian",
        "position": { "x": 125, "y": 0, "z": 1 }
      }
    ],
    "audio": {
      "filename": "7.3-3.mp3",
      "startTime": 1
    },
    "alwaysShowDialogue": true
  },
  "commands": [
    {
      "character": "Sophie",
      "position": { "x": 25, "y": 0, "z": 1 },
      "startTime": 0
    },
    {
      "character": "Brian",
      "position": { "x": 70, "y": 0, "z": 1 },
      "startTime": 0.5
    },
    {
      "character": "Sophie",
      "startTime": 1,
      "finishTime": 4,
      "dialogue": {
        "text": "Ugh, this class I'm working with is really complex.",
        "align": "left"
      }
    },
    {
      "character": "Sophie",
      "startTime": 4.42,
      "finishTime": 6.96,
      "dialogue": {
        "text": "The documentation looks confusing. What should I do?",
        "align": "left"
      }
    },
    {
      "character": "Brian",
      "startTime": 7.48,
      "finishTime": 11.3,
      "dialogue": {
        "text": "When you're dealing with classes, begin by checking the class's name and properties.",
        "align": "right"
      }
    },
    {
      "character": "Brian",
      "startTime": 11.68,
      "finishTime": 14.78,
      "dialogue": {
        "text": "This will give you an idea of its purpose and its structure.",
        "align": "right"
      }
    },
    {
      "character": "Sophie",
      "startTime": 15.54,
      "finishTime": 16.42,
      "dialogue": {
        "text": "Okay, what else?",
        "align": "left"
      }
    },
    {
      "character": "Brian",
      "startTime": 17.2,
      "finishTime": 20.78,
      "dialogue": {
        "text": "After that, you should read the methods and functions associated with the class.",
        "align": "right"
      }
    },
    {
      "character": "Brian",
      "startTime": 21.16,
      "finishTime": 25.46,
      "dialogue": {
        "text": "These can explain how to interact with the class and what you can achieve using it.",
        "align": "right"
      }
    },
    {
      "character": "Sophie",
      "startTime": 25.98,
      "finishTime": 28.62,
      "dialogue": {
        "text": "I'll try to calm down and read the documentation more carefully.",
        "align": "left"
      }
    },
    {
      "character": "Sophie",
      "startTime": 28.86,
      "finishTime": 29.72,
      "dialogue": {
        "text": "Thanks for the tips.",
        "align": "left"
      }
    },
    {
      "character": "Brian",
      "position": { "x": 125, "y": 0, "z": 1 },
      "startTime": 30.22
    },
    {
      "character": "Sophie",
      "position": { "x": -25, "y": 0, "z": 1 },
      "startTime": 30.72
    }
  ]
}