ML -建模语言-

一个库，可以将 Rust 的项目生成 UML 语言到 graphiz/dot 文件。

用法

此存储库提供为 Cargo 包 和 构建脚本。

1. 调整您的 Cargo.toml 以包括。

build = "build.rs"

[build-dependencies.mml]
version = "0.1"

2. 并将您的 build.rs 用于生成您的 uml graph/viz 和结构化矢量图形在 target/dot/$CARGO_PKG_NAME.{dot,svg}。

extern crate mml;

fn main() {
    let _ = mml::src2both("src", concat!("target/doc/", env!("CARGO_PKG_NAME")));
}

3. (可选) 从您的入口点库文件中，您可以添加生成的矢量图形。

//! ![uml](ml.svg)

4. (可选) 根据 travis-cargo 的说明，您可以准备您的 graphviz 依赖项，如下例所示。

addons:
  apt:
    packages:
      - graphviz
before_script:
  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew update           ; fi
  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install graphviz ; fi
...
script:
  - |
      travis-cargo build &&
...

功能

将此功能列表视为非标准的 UML。

• implem -- 添加一列以显示实现中的函数。
• fn-emilgardis -- 函数字段前有 fn 关键字（由 Emilgardis 提出）。

知识

这是关于 ML 相关材料的阅读清单。它包括曾经影响过 ML 设计的先前研究，以及有关 ML 的出版物。

• 使用模型转换支持工具重用
• 统一建模语言版本 2.5

许可

ml 主要在 MIT 许可证 和 Apache 许可证（版本 2.0） 的条款下分发，部分内容受各种类似 BSD 许可证的约束。

请参阅 LICENSE-APACHE 和 LICENSE-MIT 以获取详细信息。

贡献

除非您明确说明，否则您有意提交以包含在作品中的任何贡献，根据 Apache-2.0 许可证的定义，应按上述方式双许可，不附加任何额外条款或条件。