UMLをテキストベースで記述できるPlantUMLを使っている方は多いのではないでしょうか。クラス図を流用する形でER図も描くことができます。そして、データベースはすでにあり、そこからPlantUML用に出力できればいいのに、と考えている方もまた多いでしょう。 そんな方にお勧めなのがplant_erdです。各種データベースに対応したER図エクスポートソフトウェアです。 plant_erdの使い方 出力した内容をPlantUMLで表示しています。 plant_erdはSQLite3、MySQLそしてPostgreSQLに対応しています。各データベースの内容をそのままPlantUML向けに出力が可能です。特定のテーブルだけを出力対象にもできます。リレーションも再現され、データベース構造をドキュメントに書き出すのにぴったりです。 plant_erdはGo製のオープンソース・ソフトウェア（MIT

AWS上にサービスを構築するうえで、アーキテクチャー図を作る機会はままあるかと思います。 その際、draw.ioやCacooなどのウェブサービスで作っている人も多いのではないでしょうか。 今回は別のアプローチとして、PlantUMLによってコードベースでAWSのアーキテクチャー図を作る方法をご紹介します。 PlantUMLの実行環境を用意 まずは、PlantUMLの実行環境を用意します。 ローカル環境にインストールするのもいいですが、素早く試したい場合はPlantUML Web Serverを使うのが便利です。 AWSのアイコンセットを用意 PlantUMLでは、ファイルパスやURLを指定してリソースをインポートすることができます。 これにより自作の画像を組み込むことができるわけですが、ありがたいことにAWSが公式にPlantUMLのためのアイコンセットを配布しています。 awslabs/

ステートダイアグラム ステートダイアグラムは、システムまたはオブジェクトが存在しうるさまざまな状態、およびそれらの状態間の遷移を視覚的に表現します。これらは、システムが時間の経過とともに異なるイベントにどのように応答するかを捉え、システムの動的な動作をモデリングする上で不可欠です。ステートダイアグラムはシステムのライフサイクルを描写し、その挙動を理解、設計、最適化するのを容易にします。 PlantUML を使用してステートダイアグラムを作成することは、いくつかの利点を提供します： テキストベースの言語：手描きの手間なく、迅速に状態と遷移を定義し、視覚化します。 効率と一貫性：ダイアグラムの作成を効率的に行い、簡単なバージョンコントロールを確保します。 多様性：さまざまなドキュメンテーションプラットフォームと統合し、複数の出力フォーマットをサポートします。 オープンソース＆コミュニティサポー

🚀 Getting Started PlantUML is a highly versatile tool that facilitates the rapid and straightforward creation of a wide array of diagrams. Utilizing a simple and intuitive language, users can effortlessly draft various types of diagrams. For a detailed exploration of the language's capabilities and syntax, please refer to the PlantUML Language Reference Guide. If you are new to PlantUML, we recom

私の職場では関数の設計資料としてフローチャートを書く文化が根強く残っています。さらには状態遷移図やシーケンス図なども場合によっては必要になります。これらの図を作成するのに、ツールはword,ExcelやVisioなどを使っていますが、ご存じのとおりこれらのツールで作図するのは非常に面倒です(visioは幾分かマシですが)。 word,Excel,Visioでこれらの作図をする時に感じるデメリットは以下の3点です。 何か解決策は無いかなぁと色々と調べていたところ、PlantUMLというツールがあることが分かりました。PlantUMLはテキストからUMLの各種ダイアグラムを生成することが出来るフリーのツールです。 例えば、以下のようなコードを書くと @startuml Foo -> Bar : メッセージ Foo <-- Bar : レスポンス @enduml このような図を生成することが出来

[Visual Studio Code][Windows] PlantUMLの環境を設定する（シンタックスハイライト+リアルタイムプレビュー）umlPlantUMLVisualStudioCode 最近、Atom から Visual Studio Code (以下 VS Codeと表記）に乗り換えたので、PlantUML環境の作成手順をメモしときます。 環境作成 1. エディタ本体の設定 1.1. VS Code をインストールする 公式ページか VS Code をインストールします。 Visual Studio Code - Code Editing. Redefined 2. PlantUML環境の準備 ※PlantUMLのバイナリは自前で準備する必要はありません（プラグインに同梱されているため） => 最新で任意の plantuml.jar を指定する機能が追加されました。 2.1.

Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article?

PlantUMLというUMLのダイアグラム各種を簡単に書けるツールがある。 WordやExcelでフローチャートやらを描いていると、実に面倒である。GUIでクラス図を描いたりするソフトがあるけれども、シーケンス図やアクティビティ図が必要なのだ。で、それを簡単な記法からササッと生成してくれる素敵ツールがPlantUMLである。 シーケンス図の例 例えば、WordPressのテーマを自動デプロイする記事で紹介したような、WordPressのテーマ自動ビルド＆デプロイを自分はこういう手順を仕込んでいる。 GitHubのマスターへのプッシュを起点に… 1. GitHubのマスターへプッシュ 2. GitHubがTravisCIへマスターをプッシュ 3. TravisCIがマスターからプレリリースブランチを切る 4. TravisCIでコードチェックと自動ビルド 5. TravisCIがリリースへプ

この記事では、Windows 環境に Visual Studio Code と PlantUML をセットアップする手順を説明します。 PlantUML とは PlantUML は、以下のような図をテキストで素早く描くためのオープンソースプロジェクトです。 シーケンス図 / Sequence diagram ユースケース図 / Usecase diagram クラス図 / Class diagram アクティビティ図 / Activity diagram コンポーネント図 / Component diagram 状態遷移図 / State diagram オブジェクト図 / Object diagram 環境 下記の環境で動作確認しました。 Windows 10 Pro (64bit) Visual Studio Code 1.11 Java SE Runtime Environment

サーバーサイド開発担当のエンジニアが「設計と実装を進めようとしている」という背景で話を進めます。 PlantUMLは強い 「認識合わせ」という名目でホワイトボードに図を書いて会話することがよくあります。共通言語で会話してあいまいなところを少なくしたら、マネージャーも安心感がありますし、プログラマも自分がやるべきことに集中できますね。 …3日経ちました。あのとき描かれていたホワイトボードの図のとおりに、実装することになりました。認識の齟齬をなくしてくれた貴重な図です。写真に撮りました。どこに保存してたっけ。やっぱり変更したくなったらどうしましょう。またホワイトボードに書き起こす？DRYじゃないですねえ。 そこで、UML図 が登場します。表現したい図を電子データで作成、保存できて、あとで見るときも役に立ちますね。が、しかし、UML図はそれはそれでやや手間がかかるところもあります。作図を助けてく

サンプルコードの棚卸 以前、以下の記事で作成したC#ソースコードからPlantUMLを生成するサンプルプログラムですが、(長らく放置状態でしたが) 少し手直しをして、それなりに使えるようにしました。 pierre3.hatenablog.com pierre3.hatenablog.com PlantUmlClassDiagramGenerator リポジトリはこちら github.com こちらからバイナリ(.zip)をダウンロードできます。ぜひお試しください。 Release v0.5.0.0-beta 使い方 PlantUmlClassDiagramGeneratorはコンソールアプリケーションです。 以下の様にパラメータを指定して実行します。 C:\> PlantUmlClassDiagramGenerator.exe InputPath [OutputPath] [-dir] ^

サーバーサイド開発担当のエンジニアが「設計と実装を進めようとしている」という背景で話を進めます。 PlantUMLは強い 「認識合わせ」という名目でホワイトボードに図を書いて会話することがよくあります。共通言語で会話してあいまいなところを少なくしたら、マネージャーも安心感がありますし、プログラマも自分がやるべきことに集中できますね。 …3日経ちました。あのとき描かれていたホワイトボードの図のとおりに、実装することになりました。認識の齟齬をなくしてくれた貴重な図です。写真に撮りました。どこに保存してたっけ。やっぱり変更したくなったらどうしましょう。またホワイトボードに書き起こす？DRYじゃないですねえ。 そこで、UML図 が登場します。表現したい図を電子データで作成、保存できて、あとで見るときも役に立ちますね。が、しかし、UML図はそれはそれでやや手間がかかるところもあります。作図を助けてく

追記 私の作ったプラグインよりも、かなり出来がよさそうなものがリリースされています。 そちらを使ったほうが幸せそうです。 marketplace.visualstudio.com 本文 先日PlantUMLというテキストでUMLを描くためのツールのVisual Studio Codeのプラグインを作りました。 テキストをぱちぱち書きながら、プレビューを確認できるツールです。 ということで、PlantUML + Visual Studio CodeでUMLを描く方法を書いていきたいと思います。 インストール PlantUML PlantUMLのサイトからplantuml.jarをダウンロードして任意の場所においてください。 plantuml.com Graphviz PlantUMLが内部で使ってるツールです。 Graphviz - Graph Visualization Software

前回の記事の補足資料です。 pierre3.hatenablog.com 目次 使い方 設計メモ 型定義 型キーワード 修飾子 型引数 例 メンバー定義 アクセス修飾子(共通) 修飾子 (共通) プロパティ 初期化子(フィールド、プロパティ) 未対応 ネストクラス 演算子のオーバーロード 変換例 変換前 変換後のPlantUML クラス図 使い方 前回、PlantUmlClassDiagramGenerator の使い方を書くのを忘れていましたので載せておきます。 PlantUmlClassDiagramGenerator はコンソールアプリケーションです。以下のパラメータを受け付けます。 PlantUmlClassDiagramGenerator.exe SOURCE_PATH [DEST_DIR] 第1引数： SOURCE_PATH 変換元のソースファイル名または、ソースファイルを格納

前回 に引き続き、PlantUMLの話になります。 ReactiveProperty の記事もまだ途中なのですが、もうちょっと寄り道します。 今回は、Roslynで C# のソースコードから PlantUMLのクラス図を生成するプログラムを作ってみよう！というお話です。 Roslyn を使って C#のソースコードから PlantUML のクラス図を生成してみる Roslyn でメタプログラミング Roslynの導入方法、Roslynを使ったプログラミングについては、Build Insiderの記事が参考になります。 www.buildinsider.net www.buildinsider.net サンプルコード 今回も、サンプルコードをGitHubに上げておきました。 github.com CSharpSyntaxTree および CSharpSyntaxWalker 今回のプログラムで