code commenting practice Flashcards

1
Q

comment multiple lines in vs code shortcut

A

ctrl + shift + a

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
2
Q

@desc

A

Write down a description for your function

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
3
Q

@param

A

Describe all input parameters the function accepts. Make sure to define the input types.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
4
Q

@returns

A

Describe the returned output. Make sure to define the output type.

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
5
Q

@throws

A

Describe the error type the function can throw

How well did you know this?
1
Not at all
2
3
4
5
Perfectly
6
Q

@example

A

Include one or multiple examples that show the input and output

How well did you know this?
1
Not at all
2
3
4
5
Perfectly