@param and its use

I have some code in a legacy app that I can’t find anything about at all.

This appears on a few pages - if i uncomment it the whole page throws up errors. I’ve googled and can’t find anything at all about @param. I didn’t code the page so i don’t know what they are or if they’re needed.

If anyone could point me in the right direction as to what they are or if i can remove them. They’re not in all pages of the app, but quite a few. Removing them doesn’t seem to do anything, but i want to be sure.

The export class and contractor are all there and working as they should

thanks

/**

  • This is the page where the user can add, view and search for groups.
  • @param {App} app
  • @param {DataProvider} dataProvider
  • @param {LoadingProvider} loadingProvider
  • @param {AngularFireDatabase} angularFireDatabase
  • @param {AlertController} alertCtrl
  • @param {Geolocation} geolocation
  • @param {Events} events
  • @param {OneSignal} oneSignal
    */

This is just standard js-doc syntax for documenting code.

https://jsdoc.app/tags-param.html

It’s not actual code, but just docs to help while you write code. In this case, your editor will be able o display that in some sort of preview window.

1 Like

That makes sense, thanks for that.