* chore(learn): audit basic algorithm scripting * chore(learn): audit basic data structures * chore(learn): audit basic javascript * chore(learn): audit debugging * chore(learn): audit es6 * chore(learn): audit functional programming * chore(learn): audit intermidate algorithms * chore(learn): audit js projects * chore(learn): audit object oriented programming * chore(learn): audit regex * fix(learn): remove stray . * fix(learn): string to code * fix(learn): missed some * fix(learn): clarify strings Based on Randy's feedback, clarifies string instances where quotes were removed in favour of back ticks. * fix: apply suggestions - thanks Randy! :) Co-authored-by: Randell Dawson <5313213+RandellDawson@users.noreply.github.com> * fix: non-suggestion comments * chore(learn): remove comments from codes Removes the comments from the description and instruction code blocks to ensure that all relevant information is translatable. * fix: Apply suggestions from code review Co-authored-by: Shaun Hamilton <51722130+ShaunSHamilton@users.noreply.github.com> * fix: revert crowdin fix * Update curriculum/challenges/english/02-javascript-algorithms-and-data-structures/basic-algorithm-scripting/mutations.md Co-authored-by: Randell Dawson <5313213+RandellDawson@users.noreply.github.com> * fix: Apply suggestions from code review Co-authored-by: Shaun Hamilton <51722130+ShaunSHamilton@users.noreply.github.com> * Update curriculum/challenges/english/02-javascript-algorithms-and-data-structures/es6/use-destructuring-assignment-to-assign-variables-from-arrays.md Co-authored-by: Shaun Hamilton <51722130+ShaunSHamilton@users.noreply.github.com> * fix: Apply suggestions from code review Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com> Co-authored-by: Shaun Hamilton <51722130+ShaunSHamilton@users.noreply.github.com> * chore: change voice * fix: Christopher Nolan * fix: expressions would evaluate * fix: will -> would * Update curriculum/challenges/english/02-javascript-algorithms-and-data-structures/object-oriented-programming/add-methods-after-inheritance.md Co-authored-by: Randell Dawson <5313213+RandellDawson@users.noreply.github.com> * fix: to work to push * Update curriculum/challenges/english/02-javascript-algorithms-and-data-structures/basic-javascript/iterate-with-javascript-for-loops.md Co-authored-by: Shaun Hamilton <51722130+ShaunSHamilton@users.noreply.github.com> * Update curriculum/challenges/english/02-javascript-algorithms-and-data-structures/object-oriented-programming/add-methods-after-inheritance.md Co-authored-by: Randell Dawson <5313213+RandellDawson@users.noreply.github.com> Co-authored-by: Randell Dawson <5313213+RandellDawson@users.noreply.github.com> Co-authored-by: Shaun Hamilton <51722130+ShaunSHamilton@users.noreply.github.com> Co-authored-by: Oliver Eyton-Williams <ojeytonwilliams@gmail.com>
62 lines
1.4 KiB
Markdown
62 lines
1.4 KiB
Markdown
---
|
|
id: bd7123c9c441eddfaeb4bdef
|
|
title: Comment Your JavaScript Code
|
|
challengeType: 1
|
|
videoUrl: 'https://scrimba.com/c/c7ynnTp'
|
|
forumTopicId: 16783
|
|
dashedName: comment-your-javascript-code
|
|
---
|
|
|
|
# --description--
|
|
|
|
Comments are lines of code that JavaScript will intentionally ignore. Comments are a great way to leave notes to yourself and to other people who will later need to figure out what that code does.
|
|
|
|
There are two ways to write comments in JavaScript:
|
|
|
|
Using `//` will tell JavaScript to ignore the remainder of the text on the current line. This is an in-line comment:
|
|
|
|
```js
|
|
// This is an in-line comment.
|
|
```
|
|
|
|
You can make a multi-line comment beginning with `/*` and ending with `*/`. This is a multi-line comment:
|
|
|
|
```js
|
|
/* This is a
|
|
multi-line comment */
|
|
```
|
|
|
|
**NOTE:** As you write code, you should regularly add comments to clarify the function of parts of your code. Good commenting can help communicate the intent of your code—both for others *and* for your future self.
|
|
|
|
# --instructions--
|
|
|
|
Try creating one of each type of comment.
|
|
|
|
# --hints--
|
|
|
|
You should create a `//` style comment that contains at least five letters.
|
|
|
|
```js
|
|
assert(code.match(/(\/\/)...../g));
|
|
```
|
|
|
|
You should create a `/* */` style comment that contains at least five letters.
|
|
|
|
```js
|
|
assert(code.match(/(\/\*)([^\/]{5,})(?=\*\/)/gm));
|
|
```
|
|
|
|
# --seed--
|
|
|
|
## --seed-contents--
|
|
|
|
```js
|
|
```
|
|
|
|
# --solutions--
|
|
|
|
```js
|
|
// Fake Comment
|
|
/* Another Comment */
|
|
```
|