.github
api-server
client
config
curriculum
challenges
_meta
arabic
chinese
english
01-responsive-web-design
02-javascript-algorithms-and-data-structures
basic-algorithm-scripting
basic-data-structures
basic-javascript
access-array-data-with-indexes.english.md
access-multi-dimensional-arrays-with-indexes.english.md
accessing-nested-arrays.english.md
accessing-nested-objects.english.md
accessing-object-properties-with-bracket-notation.english.md
accessing-object-properties-with-dot-notation.english.md
accessing-object-properties-with-variables.english.md
add-new-properties-to-a-javascript-object.english.md
add-two-numbers-with-javascript.english.md
adding-a-default-option-in-switch-statements.english.md
appending-variables-to-strings.english.md
assignment-with-a-returned-value.english.md
build-javascript-objects.english.md
chaining-if-else-statements.english.md
comment-your-javascript-code.english.md
comparison-with-the-equality-operator.english.md
comparison-with-the-greater-than-operator.english.md
comparison-with-the-greater-than-or-equal-to-operator.english.md
comparison-with-the-inequality-operator.english.md
comparison-with-the-less-than-operator.english.md
comparison-with-the-less-than-or-equal-to-operator.english.md
comparison-with-the-strict-equality-operator.english.md
comparison-with-the-strict-inequality-operator.english.md
comparisons-with-the-logical-and-operator.english.md
comparisons-with-the-logical-or-operator.english.md
compound-assignment-with-augmented-addition.english.md
compound-assignment-with-augmented-division.english.md
compound-assignment-with-augmented-multiplication.english.md
compound-assignment-with-augmented-subtraction.english.md
concatenating-strings-with-plus-operator.english.md
concatenating-strings-with-the-plus-equals-operator.english.md
constructing-strings-with-variables.english.md
count-backwards-with-a-for-loop.english.md
counting-cards.english.md
create-decimal-numbers-with-javascript.english.md
declare-javascript-variables.english.md
declare-string-variables.english.md
decrement-a-number-with-javascript.english.md
delete-properties-from-a-javascript-object.english.md
divide-one-decimal-by-another-with-javascript.english.md
divide-one-number-by-another-with-javascript.english.md
escape-sequences-in-strings.english.md
escaping-literal-quotes-in-strings.english.md
find-the-length-of-a-string.english.md
finding-a-remainder-in-javascript.english.md
generate-random-fractions-with-javascript.english.md
generate-random-whole-numbers-with-javascript.english.md
generate-random-whole-numbers-within-a-range.english.md
global-scope-and-functions.english.md
global-vs.-local-scope-in-functions.english.md
golf-code.english.md
increment-a-number-with-javascript.english.md
initializing-variables-with-the-assignment-operator.english.md
introducing-else-if-statements.english.md
introducing-else-statements.english.md
iterate-odd-numbers-with-a-for-loop.english.md
iterate-through-an-array-with-a-for-loop.english.md
iterate-with-javascript-do...while-loops.english.md
iterate-with-javascript-for-loops.english.md
iterate-with-javascript-while-loops.english.md
local-scope-and-functions.english.md
logical-order-in-if-else-statements.english.md
manipulate-arrays-with-pop.english.md
manipulate-arrays-with-push.english.md
manipulate-arrays-with-shift.english.md
manipulate-arrays-with-unshift.english.md
manipulating-complex-objects.english.md
modify-array-data-with-indexes.english.md
multiple-identical-options-in-switch-statements.english.md
multiply-two-decimals-with-javascript.english.md
multiply-two-numbers-with-javascript.english.md
nest-one-array-within-another-array.english.md
nesting-for-loops.english.md
passing-values-to-functions-with-arguments.english.md
practice-comparing-different-values.english.md
profile-lookup.english.md
quoting-strings-with-single-quotes.english.md
record-collection.english.md
replacing-if-else-chains-with-switch.english.md
return-a-value-from-a-function-with-return.english.md
return-early-pattern-for-functions.english.md
returning-boolean-values-from-functions.english.md
selecting-from-many-options-with-switch-statements.english.md
shopping-list.english.md
stand-in-line.english.md
store-multiple-values-in-one-variable-using-javascript-arrays.english.md
storing-values-with-the-assignment-operator.english.md
subtract-one-number-from-another-with-javascript.english.md
testing-objects-for-properties.english.md
understand-string-immutability.english.md
understanding-boolean-values.english.md
understanding-case-sensitivity-in-variables.english.md
understanding-undefined-value-returned-from-a-function.english.md
understanding-uninitialized-variables.english.md
updating-object-properties.english.md
use-bracket-notation-to-find-the-first-character-in-a-string.english.md
use-bracket-notation-to-find-the-last-character-in-a-string.english.md
use-bracket-notation-to-find-the-nth-character-in-a-string.english.md
use-bracket-notation-to-find-the-nth-to-last-character-in-a-string.english.md
use-conditional-logic-with-if-statements.english.md
use-multiple-conditional-ternary-operators.english.md
use-the-conditional-ternary-operator.english.md
use-the-parseint-function-with-a-radix.english.md
use-the-parseint-function.english.md
using-objects-for-lookups.english.md
word-blanks.english.md
write-reusable-javascript-with-functions.english.md
debugging
es6
functional-programming
intermediate-algorithm-scripting
javascript-algorithms-and-data-structures-projects
object-oriented-programming
regular-expressions
03-front-end-libraries
04-data-visualization
06-information-security-and-quality-assurance
08-coding-interview-prep
09-certificates
portuguese
russian
spanish
adddir.js
translatemd.js
formattingConversion
math-challenges
requiresTests
schema
.babelrc
.editorconfig
.eslintignore
.eslintrc
.npmignore
.prettierrc
.travis.yml
CHANGELOG.md
LICENSE.md
addAssertsToTapTest.js
challengeTitles.js
commitizen.config.js
commitlint.config.js
create-challenge-bundle.js
getChallenges.js
gulpfile.js
index.js
lib.js
md-translation.js
mongoIds.js
package-entry.js
package-lock.json
package.json
repack.js
test-challenges.js
unpack.js
unpacked.css
unpacked.js
unpackedChallenge.js
utils.js
docs
guide
news
tools
.editorconfig
.eslintignore
.eslintrc
.gitattributes
.gitignore
.node-inspectorrc
.prettierrc
.snyk
.travis.yml
.vcmrc
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE.md
README.md
docker-compose-shared.yml
docker-compose.yml
lerna.json
netlify.toml
package-lock.json
package.json
sample.env
62 lines
1.7 KiB
Markdown
62 lines
1.7 KiB
Markdown
---
|
|
id: bd7123c9c441eddfaeb4bdef
|
|
title: Comment Your JavaScript Code
|
|
challengeType: 1
|
|
---
|
|
|
|
## Description
|
|
<section id='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 <code>//</code> will tell JavaScript to ignore the remainder of the text on the current line:
|
|
<blockquote>// This is an in-line comment.</blockquote>
|
|
You can make a multi-line comment beginning with <code>/*</code> and ending with <code>*/</code>:
|
|
<blockquote>/* This is a<br>multi-line comment */</blockquote>
|
|
<strong>Best Practice</strong><br>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 <em>and</em> for your future self.
|
|
</section>
|
|
|
|
## Instructions
|
|
<section id='instructions'>
|
|
Try creating one of each type of comment.
|
|
</section>
|
|
|
|
## Tests
|
|
<section id='tests'>
|
|
|
|
```yml
|
|
tests:
|
|
- text: Create a <code>//</code> style comment that contains at least five letters.
|
|
testString: 'assert(code.match(/(\/\/)...../g), "Create a <code>//</code> style comment that contains at least five letters.");'
|
|
- text: Create a <code>/* */</code> style comment that contains at least five letters.
|
|
testString: 'assert(code.match(/(\/\*)([^\/]{5,})(?=\*\/)/gm), "Create a <code>/* */</code> style comment that contains at least five letters.");'
|
|
|
|
```
|
|
|
|
</section>
|
|
|
|
## Challenge Seed
|
|
<section id='challengeSeed'>
|
|
|
|
<div id='js-seed'>
|
|
|
|
```js
|
|
|
|
```
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</section>
|
|
|
|
## Solution
|
|
<section id='solution'>
|
|
|
|
|
|
```js
|
|
// Fake Comment
|
|
/* Another Comment */
|
|
```
|
|
|
|
</section>
|