Angular use compodoc

發表於： 2020-07-20 分類於：筆記

字數： 260 閱讀：≈ 1分鐘瀏覽：

Angular use compodoc

compodoc是一個用於產生 Angular 靜態網頁的工具

Angular 使用 compodoc 產生說明文件

安裝compodoc

以 local 模式安裝

npm install --save-dev @compodoc/compodoc

產生檔案

./node_modules/.bin/compodoc -p tsconfig.json

RUN server

./node_modules/.bin/compodoc -s

以global(全域) 模式安裝

npm install -g @compodoc/compodoc

產生文件

compodoc -p tsconfig.json

啟用本地文件網站

compodoc -p tsconfig.json -s

使用 npx(推薦)

npx compodoc -p tsconfig.json -s -r 8888

指令

p : 表示產生文件
s : 啟用文件網站

jsDoc Tags

@Injectab()

export class HelloService{

constructor(){

}

/**

* Represents a hellWord.

* @param {string} UserName - The UserName of the hellWord.

* @param {string} age - The age of the hellWord.

*/

hellWord(UserName: string, age : string) {

}

}