Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to write documentation of my functions in angular

I want to write documentation of my Angular project. Can anyone guide me what is the default way to write documentation for Angular? I have searched it online but unable to find any answer. All I found is something related to compodoc. But I want to document each and every function of my project.

like image 503
Zohab Ali Avatar asked Oct 28 '25 15:10

Zohab Ali


1 Answers

If you're building an AngularJS (1.x) project: Many javascript developers use JSDoc as a way to document their code (http://usejsdoc.org/).

If you are building an Angular(2+) project: Microsoft released a standard for typescript projects: https://github.com/Microsoft/tsdoc

like image 75
Tim Patat Avatar answered Oct 30 '25 08:10

Tim Patat



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!