FAQ: Functions - Documenting Functions

Frequently Asked Questions JavaScript FAQ
1

Community%20FAQs%20on%20Codecademy%20Exercises
Community%20FAQs%20on%20Codecademy%20Exercises1000×208 141 KB

This community-built FAQ covers the “Documenting Functions” exercise from the lesson “Functions”.

Paths and Courses
This exercise can be found in the following Codecademy content:

Learn TypeScript

FAQs on the exercise Documenting Functions

There are currently no frequently asked questions associated with this exercise – that’s where you come in! You can contribute to this section by offering your own questions, answers, or clarifications on this exercise. Ask or answer a question by clicking reply (reply) below.

If you’ve had an “aha” moment about the concepts, formatting, syntax, or anything else with this exercise, consider sharing those insights! Teaching others and answering their questions is one of the best ways to learn and stay sharp.

Join the Discussion. Help a fellow learner on their journey.

Ask or answer a question about this exercise by clicking reply (reply) below!
You can also find further discussion and get answers to your questions over in Language Help.

Agree with a comment or answer? Like (like) to up-vote the contribution!

Need broader help or resources? Head to Language Help and Tips and Resources. If you are wanting feedback or inspiration for a project, check out Projects.

Looking for motivation to keep learning? Join our wider discussions in Community

Learn more about how to use this guide.

Found a bug? Report it online, or post in Bug Reporting

Have a question about your account or billing? Reach out to our customer support team!

None of the above? Find out where to ask other questions here!

2

Exercises like these are not helpful at all. I do not want a lesson in how to correctly predict whether you want me to type “string input” or “input string” in a comment. The answer is completely ambiguous and irrelevant. This kind of exercise is discouraging and hinders the learning process.

1 Like
3

I think the purpose of the exercise is to show how to provide extra documentation for your functions which can be shown in the IDE for other devs using that function. I don’t think it’s irrelevant as you may see or be expected to provide these comments in a real life project, and the example is just the convention used to do this.

1 Like
4

I believe there is an error on this given example:

` /**

  • Returns the sum of two numbers.
  • @param x - The first input number
  • @param y - The second input number
  • @returns The sum of x and y

*/
function getSum(x: number, y: number): number {
return x + y;
}
} //Error`

This bracket should not be here.

5

probably the example only shows a part of the code, should not be understood as standalone code. it makes no difference to the exercise tho