Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What is @license and @publicApi inside comments in Angular or JavaScript

I built my Angular app then looked at the built code where I found @license or @publicApi inside comments like you can see in image attached below. I don't know what this thing is and How to create them. Please if anyone know then kindly comment your answer below, It'll be helpful for me to know something new.

enter image description here

like image 766
Harsh Lodhi Avatar asked Oct 16 '25 12:10

Harsh Lodhi


1 Answers

This jsDoc annotations used by Google. A good guide in writing those: https://devdocs.io/jsdoc/

For example the @license can be explained: https://jsdoc.app/tags-license.html

 The @license tag identifies the software license that applies to any portion of your code.

 You can use any text to identify the license you are using. 

The public api one seems like it's something Google specific. All these are annotations. They don't change the way the code works.

JSDoc's purpose is to document the API of your JavaScript application or library. It is assumed that you will want to document things like modules, namespaces, classes, methods, method parameters, and so on.

like image 105
Athanasios Kataras Avatar answered Oct 18 '25 08:10

Athanasios Kataras



Donate For Us

If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!