php - コードフローチャートを書くための提案

Question

私は今年の夏にインターンシップの終わりに近づいており、主にPHP、MySQL、JavaScript（jQuery）を含むメンター向けのツールを開発しました。プログラムのコード構造とファイル間の関係を示す読みやすいドキュメントを作成するためのテンプレート、提案、またはリンクを持っている人はいますか？

これらの人はプログラマーですが、上記のどの言語でもあまり経験がないので、比較的単純なものにしたいと思います。

編集：

ある種のフローチャートが進むべき道のようです（これは理にかなっています）。ページ上のすべてのクラスファイルから始めますか？または、1つずつ開始し、すべての詳細を把握して分岐し、複雑になるにつれて再配置しますか。

score 2 · Accepted Answer

マインドマッピングはここで役立つかもしれません。FreeMind、XMind、iMindqなど、私が推奨できる無料のツールがいくつかあります。

score 1 · Accepted Answer

まず、ソフトウェアの機能（機能仕様）と、それを構築、実行、およびテストする方法について説明します。優れた開発者は、バスのヒット率が低いコードを作成しないようにする方法を教えてください。

それが終わったら、機能仕様からソースコードにポインタを追加して、ソースコードのどのビットが機能のどのビットを実装するのに役立つかを特定できます。

[私が「ポインタ」と言うときは、いくつかの機能を識別/説明するセクションに、対応するソースコードのURLや名前を追加することを意味します。]

score 1 · Accepted Answer

PHPドキュメントをマークアップするDoxygenをチェックしてみてください。ドットが使用可能な場合、Doxygenはファイルの依存関係グラフを自動的に生成し、関数のグラフを呼び出し、クラスの祖先グラフも生成できます。

ただし、DoxygenはMySQLソースの文書化を正確にサポートしていません。ただし、Javascriptコードを文書化するための一般的なperlスクリプトがいくつかあるようです。

Doxygenで生成されたサンプルのドキュメントもご覧になることをお勧めします。

score 1 · Accepted Answer

無料のUMLツールを検索するか、Microsoft Visioにアクセスできる場合は、それを使用してUML図を作成します。

score 1 · Accepted Answer

OmniGraffleの使用をお勧めします。これはOSXアプリケーションですが、驚異的です。

http://www.omnigroup.com/applications/OmniGraffle/

score 0 · Accepted Answer

私は多くのプロジェクトでこれを行ってきました。実際、既存のフローチャートで作業を開始すると、自分で参照できるようにある種のフローチャートを作成し、それをリポジトリにチェックインすることを学びました。

私はフローチャートタイプの図を好みます（多分あなたが考えているものに加えて）。私はOpenOfficeを使用して、さまざまな部分や決定のために円、長方形、三角形などを描画します。作成してからコピーし、必要に応じてテキストを変更すれば、それほど時間はかかりません。矢印と同じように、たくさん作ってから好きな場所に動かしてください。

私はこれを行うツールを探してみましたが、OOよりもはるかに使いやすい場合は、バグが多くクラッシュする傾向があります。安定している場合は、これ以上高速ではなく、OOほど多くの描画オプションがなかった可能性があります。

score 0 · Accepted Answer

私は無料のPlantUMLツールを使用しました。このツールには、他のいくつかのプラグインと一緒にEclipse用のプラグインもあります。このツールに関して興味深いのは、いくつかの欠点とともに多くの利点がある図を作成するためにテキストスクリプトを作成する必要があることです。たとえば、UMLダイアグラムの一部を簡単にコピーして貼り付けたり、ダイアグラムをすばやく変更したり、mediawikiなどと統合したりできます。

いくつかの例

@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response

Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
@enduml

と

@startuml
actor Foo1
boundary Foo2
control Foo3
entity Foo4
database Foo5
Foo1 -> Foo2 : To boundary
Foo1 -> Foo3 : To control
Foo1 -> Foo4 : To entity
Foo1 -> Foo5 : To database
@enduml

と

@startuml

User -> (Start)
User --> (Use the application) : A small label

:Main Admin: ---> (Use the application) : This is\nyet another\nlabel

@enduml

と

@startuml

[*] --> State1
State1 --> [*]
State1 : this is a string
State1 : this is another string

State1 -> State2
State2 --> [*]

@enduml

@startuml

object user {
  name = "Dummy"
  id = 123
}

@enduml

すべての例はPlantUMLの公式ウェブサイトから引用したものです

php - コードフローチャートを書くための提案

編集：

7 に答える 7

Related

Reference