TypeDocによるドキュメントの作成

アドインのほうは丁寧に書きたいため手動ででドキュメントを作成したが、ライブラリの関数については、自動生成してみてもいいかと思うので、下記ページを見ながら自動生成を試みる。

まず、TypeDocのインストール。

ライブラリに含める必要はないので-Dオプションをつける。

$ npm install -D typedoc

最初にTypeDocと書いてやったらエラーになった。大文字はだめですね。

またpackage.jsにスクリプトを登録する

"scripts": {
    "build": "tsc",
    "prepare": "npm run build",
    "test": "jest",
    "typedoc": "typedoc --out ./docs/ ./src/"
  },

また、docsフォルダができるので、.gitignoreと.npmignoreを対応

これで、あとはスクリプトを実行するだけ

$ npm run typedoc

あっという間にドキュメントができた。

こんな感じ

なんとREADMEもしっかりhtmlにしてindex.htmlにしてくれるんですね。

ST_FUNC開発日記