Search⌘ K
AI Features
Home
Courses
Mastering Mobile Application Development with Ionic

Marking Up Your Files

Explore how to properly mark up your Ionic application files by using JSDoc tags supported by Compodoc to document code components and methods effectively. Understand the process of creating Sass documentation using SassDoc annotations, enabling clearer styles management. This lesson helps you improve project clarity, collaboration, and documentation quality essential for efficient mobile app development.

We'll cover the following...

Documenting with Compodoc

Currently, the options for documenting your classes with JSDoc are limited when using Compodoc to using only the following tags:

  • The @example tag
  • The @ignore tag
  • The @link tag
  • The @param {type} Name Description tag
  • The @returns tag

If you’re familiar with using a documentation library such as JSDoc or YUIDoc, this might feel restrictive at first. Surprisingly, this is ...