パッケージ、リポジトリ、アプリカテゴリを検索

dcdg のカバー
パッケージ詳細v4.1.0

dcdg

Dartパッケージからクラス図(UMLなど)を自動的に生成するツールです。

AndroidiOSmacOSWindowsLinux
30日間ダウンロード
444
いいね数
179
Pub ポイント
120

パッケージをインストール

flutter pub add dcdg

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

dcdg は、Dart パッケージからクラス図(UML など)を自動的に生成する開発者ツールです。Dart コードの構造を分析し、クラス、関係性、継承階層を可視化することで、複雑なコードベースの理解を助けます。ドキュメント作成、オンボーディング、デザインレビューに最適で、Android、iOS、macOS、Windows、Linux などの複数のプラットフォームをサポートしています。Flutter pub を通じて統合可能で、オープンソースであり、GitHub にホストされています。

用途

  • コードベースのドキュメント
  • 新規開発者のオンボーディング
  • デザインの可視化
  • リファクタリングの計画
  • 技術文書

主な機能

  • 自動UML図生成
  • マルチプラットフォームプロジェクトをサポートしています
  • オープンソースかつ拡張可能
  • Flutter pub との統合
  • クラス関係の可視化

適している対象

  • Dart開発者
  • チームドキュメント
  • 大規模なコードベース
  • ソフトウェアアーキテクト
  • 教育的目的

注意事項

  • Dart コードの分析が必要です
  • 出力の品質はコード構造に依存します
  • リアルタイムの更新ではない
  • 制限されたカスタマイズオプション
  • 静的解析に最適

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Build Status

Dart Class Diagram Generator

A small command line utility to generate a class (UML or similar) diagram from a Dart package.

Examples

Below is a UML diagram of the dcdg source code, created with dcdg. You can find the PlantUML source in the example/ directory.

Example UML Diagram

Installation

Install from pub:

dart pub global activate dcdg

Install from clone:

dart pub global activate -s path .

Usage

From inside a Dart package directory:

dart pub global run dcdg

This will dump a PlantUML file to stdout. You can save it to a file instead with the -o option.

If you'd like to create a Mermaid file instead, pass the -b option with mermaid as its argument:

dart pub global run dcdg -b mermaid

See --help for more options, including ways to filter what ends up in the output. You can find the help contents in USAGE.txt as well.

Examples

There are test fixtures in test/fixtures/. Each Dart package in this directory contains various (fake) classes. Try running DCDG against these fixtures to familiarize yourself with how it works.

Contributing

Pull requests are welcome! It is intended to be reasonably straightforward to add a new output format. Take a look at the DOT format implementation in lib/src/builders for an example.

If you have found a bug or have a feature request please open an issue.

Development

Format code using the tool/format.sh script. It will have a non-zero exit code if the formatting changed. That's fine, it does that so it can be used in CI.

Run the full test suite (including unit and functional tests) with tool/check.sh.

If you change the user interface or add features you should run tool/docs.sh to regenerate documentation and other resources. This script requires PlantUML.

カテゴリー

依存関係

依存関係一覧 3 件

ソースリポジトリ

このパッケージを使用しているプロジェクト

データはまだありません。