ianhuang筆記THE ADVENTURER'S JOURNAL
知識世界・持續探索中

ADVENTURE JOURNAL · 探索筆記

Compodoc:產生 Angular 檔案與檢查輸出

任務導覽 TABLE OF CONTENTS

修正 CLI 選項與註解範例,補上輸入 tsconfig、版本固定及檔案範圍。

適用:Angular原有NgModule專案的設計情境;新程式片段採Angular20 standalone方式,舊版差異另列。先使用與專案相容的Node/TypeScript。

安裝與產生

在既有Angular專案安裝與該專案相容的版本,並儲存lockfile:

npm install --save-dev @compodoc/compodoc
npx compodoc -p tsconfig.app.json -d documentation
npx compodoc -s -d documentation -r 8888

-p指定TypeScript專案檔,不是「產生」開關;-d指定輸出目錄、-s啟動檔案server、-r指定port。若workspace的tsconfig僅有references或沒有來源,先選真正包含app檔案的配置,按安裝版本npx compodoc --help確認。

檔案註解

import { Injectable } from '@angular/core';
/** 提供本地問候文字,不發出網路請求。 */
@Injectable({ providedIn: 'root' })
export class HelloService {
  /** @param userName 要顯示的名稱 @returns 問候字串 */
  hello(userName: string): string { return `你好 ${userName}`; }
}

原@Injectab()拼字錯誤改為Injectable。TypeScript已有型別,不必在每個param重複手寫容易失真的型別。

確認與限制

檔案網站應包含HelloService、方法與說明,點連結能檢視相應結構。若缺服務先查tsconfig.include/exclude和工具解析錯誤。coverage只表示有沒有註解,不能證明內容正確;介面HTTP契約還需OpenAPI等獨立文件。

產物可能含內部路徑、路由及程式碼,不無條件公開到網路。升級Angular後核對Compodoc支援,不要用全域性未知版本生成與CI不同的檔案。

參考資料

冒險者留言

comments powered by Disqus

搜尋筆記

輸入關鍵字,探索所有筆記。

ESC 關閉 · 搜尋標題、標籤與文章全文