Building TypeScript Applications with JSDoc
1h 9mAdvanced2025-01-08
Authors
Eve Porcello
Software Developer and Instructor
Course details
Great documentation is vital for collaborating on a developer team. This course offers a comprehensive introduction to documenting TypeScript code using JSDoc. Instructor Eve Porcello shows you how to enhance your TypeScript projects by integrating JSDoc annotations, providing clear and detailed type information. Eve covers the essentials of JSDoc syntax, best practices for documentation, and advanced techniques for generating robust API documentation. Check out this course to gain the skills to create professional-grade documentation that facilitates better developer collaboration and project success.
Learning objectives
Effectively document TypeScript code using JSDoc annotations.
Understand how to generate comprehensive API documentation and utilize advanced documentation features for technical documentation.
Learn to annotate functions, classes, and modules with confidence.
Learning objectives
Effectively document TypeScript code using JSDoc annotations.
Understand how to generate comprehensive API documentation and utilize advanced documentation features for technical documentation.
Learn to annotate functions, classes, and modules with confidence.
Skills covered
TypeScriptEcma InternationalJavaScriptWeb Development ToolsFront-End Web DevelopmentWeb DevelopmentProgramming LanguagesOpen SourceSoftware DevelopmentOne-Off
Concepts
0. Introduction
- 01 - Enhancing TypeScript applications with JSDoc
- 02 - What you should know
1. Incorporating JSDoc
- 03 - Configuring your TypeScript project
- 04 - Writing a TypeScript function
- 05 - Annotating a TypeScript function
- 06 - Adding additional information with tags
- 07 - Documenting classes
- 08 - Documenting class methods
2. JSDoc Configuration
- 09 - Generating a website with JSDoc
- 10 - Selecting a custom theme
- 11 - Enabling Markdown support
- 12 - Adding links between files
- 13 - Challenge - Adding documentation to a class
- 14 - Solution - Adding documentation to a class
3. Working with Advanced Types
- 15 - Documenting generic types
- 16 - Incorporating TypeDoc
- 17 - Building type guards with documentation
- 18 - Creating utility types
4. Working with Files
- 19 - Generating Markdown docs
- 20 - Adding a custom README file
- 21 - Documenting a REST API
- 22 - Challenge - Adding POST and PUT documentation
- 23 - Solution - Adding POST and PUT documentation
Conclusion
- 24 - Next steps