Documenting Angular projects

1

JSDoc

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.

#Documentation #Documentation As A Service & Tools #Developer Tools 48 social mentions

2

Compodoc

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).

#Documentation #Documentation As A Service & Tools #Knowledge Base 10 social mentions

3

Angular.io

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.

#JavaScript Framework #JS Library #Web Development Tools 283 social mentions