This project was generated with Angular CLI version 16.2.7.
If you are importing this project for the first time, you will need to install the dependencies.
Run npm install or npm i.
Run npm install -g @compodoc/compodoc if you haven't already and want to use it.
Compodoc is a documentation tool. It will build files based on certain comments.
In tsconfig.doc.json, you can define which file is "read" and which is ignored.
/**
* this kind of comment is supported by Compodoc
*/
YourFunctionInAngular()
You can also add more detail with some tags.
For example : @param {string} username the name of the target user
This situation discribes the function have an input parameter named username. This parameter is a string and the name of the target user indicates its purpose.
Run compodoc -p tsconfig.doc.json -s will build and Serve the documentation on localhost (8080 by default).
In Package.json, you can define a command in scripts.
For this project, you can run npm run compodoc. It will run this command compodoc -p tsconfig.doc.json -s -r 4201, so documentation will be available on localhost:4201
Run ng serve for a dev server. Navigate to http://localhost:4200/. The application will automatically reload if you change any of the source files.
Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.
Run ng build to build the project. The build artifacts will be stored in the dist/ directory.
Run ng test to execute the unit tests via Karma.
Run ng e2e to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
To get more help on the Angular CLI use ng help or go check out the Angular CLI Overview and Command Reference page.