Our great sponsors
-
-
-
SurveyJS
Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App. With SurveyJS form UI libraries, you can build and style forms in a fully-integrated drag & drop form builder, render them in your JS app, and store form submission data in any backend, inc. PHP, ASP.NET Core, and Node.js.
-
-
compodoc
:notebook_with_decorative_cover: The missing documentation tool for your Angular, Nest & Stencil application
-
-
InfluxDB
Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.
If you are starting documenting a project for the first time, it is a good idea to go over popular framework/library docs and see how people usually document things. For example, documentation sites for RxJS, NgRx, and Angular itself can be super useful to up your skills at documenting software.
If you are starting documenting a project for the first time, it is a good idea to go over popular framework/library docs and see how people usually document things. For example, documentation sites for RxJS, NgRx, and Angular itself can be super useful to up your skills at documenting software.
Keep documentation close to what is being documented: in Angular projects, JSDoc comments can be used to document components, pages and so on write on top of the source code, which is very useful and saves time
Finally, we have come to a point where we want our JSDoc comment documentations to turn into a full scale documentation website, which we can share with new developers instead of providing lengthy Word documents, or which can be used by the team to search for explanations and direction during development. Thankfully, there are amazing tools that help us build such sites easily, with just a console command. Today we will be exploring one such tool called Compodoc, which is a documentation website generator specifically designed for Angular projects (it also supports Nest and Stencil, but we will focus on Angular).
If you are starting documenting a project for the first time, it is a good idea to go over popular framework/library docs and see how people usually document things. For example, documentation sites for RxJS, NgRx, and Angular itself can be super useful to up your skills at documenting software.