dart - Dart のコード ドキュメント

Question

Dart アプリケーション コードからコード ドキュメントを生成するためのコード ドキュメント構文とツール サポートはありますか。これは、C/C++ 用の Doxygen に似ています。私は、doxygen-syntax よりも Markdown スタイルの構文を使用することを好みます。

Answer 1

DartDoc ツール (markdown を使用) は API ドキュメントを作成します ( api.dartlang.orgにあります) 。

これは、独自のコードで DartDoc を使用するための API リファレンスについて説明しています

ここのReadme.txtには、コード コメントをフォーマットして API ドキュメントを生成する方法が示されています。

Answer 2

///I am the beerclass
class BeerClass{
  ///this is a beer variable
  String beername;

  ///this is a beer method
  String get getBeer => "beer for the people";
}

Darteditor: Tools->Generate Dartdocに入るだけです。新しいディレクトリdocsを取得し、ブラウザで index.html を起動します。クラス、変数、およびメソッドにドキュメントが追加されました。