Unverified details These details have not been verified by PyPI Project links Homepage Download Meta License: BSD License (BSD) Author: Yuya Nishihara Classifiers Development Status 4 - Beta Environment Console Web Environment Framework Sphinx :: Extension Intended Audience Developers License OSI Approved :: BSD License Operating System OS Independent Programming Language Python Topic Documentatio
Doxygen You can use Doxygen and PlantUML together to integrate UML diagrams into generated documentation. You will find more information in the official documentation.
Sphinx には Sphinx 拡張(Sphinx extension)と呼ばれるプラグイン機能があります。 Sphinx 拡張を使うとドキュメントを書くのがより便利になったり、 ドキュメントの表現がより豊富になったりします。 今日はその Sphinx 拡張の中から僕がよく使うもの、便利そうで使ってみたいものを それぞれいくつかピックアップしてご紹介します。 sphinx.ext.todo Sphinx に同梱されている拡張モジュールで、ドキュメントに ToDo を書き残すことができます。 有効にするには conf.py に以下の記述を追加します。 # sphinx.ext.todo モジュールを読み込む extensions += ['sphinx.ext.todo'] # ToDo 項目を表示する (デフォルトは表示しない; False) todo_include_todos = T
はじめに 目次 戻る はじめに_ テキストから UML を生成する PlantUMLを用いてUML図を描く。 参考URLは以下のとおり。 PlantUML(英語) プログラマーズ雑記帳:PlantUML の使い方 UMLの用語は基本的にマーチン・ファウラー著: UML モデリングのエッセンス 第3版, 翔泳社, 2005年にしたがう。 目次_ インストール Windows 7上にPlantUMLをインストール Ubuntu上にPlantUMLをインストール UML図の作成 PlantUMLでクラス図を描く PlantUMLでオブジェクト図を描く PlantUMLシーケンス図を描く PlantUMLでパターン図を描く PlantUMLで配置図を描く PlantUMLでユースケース図を描く PlantUMLで状態マシン図を描く PlantUMLでアクティビティ図を描く 戻る_ Yuichi G
Remotely access and manage devices to provide on-demand IT support. Be Efficient Support Remotely ISL Light is an easy-to-use remote desktop software for security-conscious users. It comes at a great price-performance. ISL Light is a powerful tool that helps IT staff and support technicians solve problems remotely, either through unattended access, remote support or even though screen-sharing on m
PlantUML でのダイアグラムの見栄えを変更する skinparam について説明します。 @startuml{plantuml_skinparam_sample.png} skinparam backgroundColor #EEEBDC skinparam sequence { ArrowColor DeepSkyBlue ActorBorderColor DeepSkyBlue LifeLineBorderColor blue LifeLineBackgroundColor #A9DCDF ParticipantBorderColor DeepSkyBlue ParticipantBackgroundColor DodgerBlue ParticipantFontName Impact ParticipantFontSize 17 ParticipantFontColor #A9
クラス図の例 クラスボックス もっともシンプルなクラス図 属性と操作が記載されたクラス プロパティ、属性と関連 関連 プロパティを属性で表した場合 プロパティを関連で表した場合 誘導可能性矢印 汎化 依存関係 戻る クラス図の例_ マーチン・ファウラー著 UMLモデリングのエッセンス 第3版 図3.1をPlantUMLで描くと以下のようになる。 上記のクラス図は以下のPlantUML記法で生成される。 Fig3.1.puml(テキストファイル) ' マーチン・ファウラー著 UMLモデリングのエッセンス 第3版 図3.1 @startuml{Fig3.1.png} title 簡単なクラス図 class "Order (注文)" as Order { dateReceived: Date [0..1] isPrepaid: Boolean [1] number: String [1] pri
@startuml{plantuml_class_specclass.png} enum FigureType { FigureType_unknown=-1 FigureRect FigurePolygon FigureEllipse } abstract Figure class Rect interface Comparable { {abstract} int compare(Comparable *other) } Figure <|-- Rect Rect .|> Comparable @enduml スポットとステレオタイプ シーケンス図と同様にクラス定義の後にステレオタイプを書く事ができます。 また、ステレオタイプで C, I, A, E 以外のスポットを指定することができます。 class クラス名 <<(スポット文字, 色) [ステレオタイプ名]>> @startuml
JQuery integration Imagine that you could directly use PlantUML source code into HTML, something like: And that will display this: This would be nice. Well, using JQuery library, this will work. You just have to use the following header in your html file: <head> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="[[jquery_plantuml.js|jquery_plantuml.js]]"><
大きいプロジェクトだとクラスとかメソッドがいっぱいあって、それぞれ呼び出し合ったりして、もー意味わかんない。構造を視覚的に追えると良いんだけど、クラス図とかコールグラフを手作業で作ってると埒があかない。 ということで、自動でドキュメント + クラス図やコールグラフを作ってくれるツール Doxygen と Graphviz がとっても便利だったのでメモっておく。 とりあえず説明する上での環境は Mac OS X 10.7 + Homebrew ということで。Doxygen と Graphviz 自体は、UNIX 系の OS ならどれでも動かせるんだと思う。 まずは Homebrew からインストールする。 # brew install doxygen graphviz インストールできたら、解析したいソースコードのあるディレクトリで Doxygen を使う。今回解析するコードは Java だ
卒論生成たけなわの皆さんお疲れ様です。終わった皆さんお疲れ様です。 卒論ページを埋めるためにクラス図を生成する必要がありましたので、メモです。 暇になったら加筆します。 クラス図とかソースコードの依存関係の図を自動生成したい ソースコードが先にあってUMLを作るためのツールは探すと有料がほとんど。 でもDoxygenとGraphvizを組み合わせると無料でできるらしい。 というわけで用意するものはDoxygenとGraphvizとソースコードです。C++、C、Java、Objective-C、Python、IDL、 PHP、C#、Dに対応しているそうです。 まずGraphvizとDoxygenを下記からインストールします。 Graphviz | Graphviz - Graph Visualization Software Doxygen すべてデフォルトでOK Doxygenの設定 楽天
Hmm, this seems to be a bit of an old question, but since I've been messing about with Doxygen configuration last few days, while my head's still full of current info let's have a stab at it - I think the previous answers almost have it: The missing option is to add COLLABORATION_GRAPH = YES in the Doxyfile. I assume you can do the equivalent thing somewhere in the doxywizard GUI (I don't use doxy
ブロック図生成ツール blockdiag¶ blockdiag シリーズはシンプルなテキストからブロック図などの画像を生成する画像生成ツール群です。 blockdiag を用いると以下のような図が簡単に生成できます。 blockdiag の主な機能: 数種類の図に対応 ブロック図 (blockdiag コマンド) シーケンス図 (seqdiag コマンド) アクティビティ図 (actdiag コマンド) 論理ネットワーク図 (nwdiag コマンド) テキストベースの定義ファイルから画像ファイルを生成 (graphviz 風の文法を採用) 定義にあわせて図の配置を自動的に決定 (自動レイアウト) Sphinx, Trac, Redmine, 各種 Wiki エンジン等、多様なシステムへの画像埋め込みに対応 Enjoy documentation with blockdiag !
テキストから UML を生成する PlantUML についての解説記事を書いてみました。 PlantUML の使い方 (今回) シーケンス図 クラス図 オブジェクト図 パッケージ図 ユースケース図 アクティビティ図 状態遷移(ステートマシン)図 コンポーネント図 配置図 skinparam PlantUML 実行用のバッチファイル 今回は PlantUML の使い方の説明です。 PlantUML とは インストール 日本語 コマンドライン Doxygen との連携 Doxygen 連携用スクリプト その他のツールとの連携 オンラインデモ PlantUML とは 最近、プログラムの設計書などで UML を使うのが浸透してきていますが、 この UML を書くのはわりと面倒です。 CASE ツール, Doxygen などでは、クラス図を自動生成してくれますが、 ユースケース図やシーケンス図は自分
BambooHR is all-in-one HR software made for small and medium businesses and the people who work in them—like you. Our software makes it easy to collect, maintain, and analyze your people data, improve the way you hire talent, onboard new employees, manage compensation, and develop your company culture. It’s designed to set you free to focus on what matters most—your people.
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く