dartdoc作ってみる - Githubissues

TetsuFe / flutter_novel

Flutter製のノベルゲーム

https://tetsufe.github.io/flutter_novel/#/

3 stars 1 forks source link

dartdoc作ってみる #14

Closed TetsuFe closed 4 years ago

TetsuFe commented 4 years ago

why

dartdocでクラスの説明を生成してみたい
- docコメントを書いてみたり
- 忘れた時に読み返すのが楽そう

https://dart.dev/tools/dartdoc

試した

$ cd プロジェクトルート $ dartdoc

dart-ffiなどの無駄なdocsが生成されてしまう

https://github.com/dart-lang/dartdoc/issues/1949

https://sakebook.hatenablog.com/entry/2020/01/12/210346

とりあえずこの問題解消までは保留

TetsuFe commented 4 years ago

$ dartdoc --exclude 'dart:async,dart:collection,dart:convert,dart:core,dart:developer,dart:io,dart:isolate,dart:math,dart:typed_data,dart:ui,dart:ffi,dart:html,dart:js,dart:js_util'

で作ると、いい感じにdartsdkを含まないドキュメントが生成できた。.gitignoreで標準ではignoreされている設定になっていることから、とりあえずローカルで使うことにする