4

ビジュアルスタジオでこのようなコメントを生成できるツールは何ですか? 特に、以下に示すコメントのような図を作成する機能。

//
//  +---------------+
//  |               |
//  | start_connect |<---+
//  |               |    |
//  +---------------+    |
//           |           |
//  async_-  |    +----------------+
// connect() |    |                |
//           +--->| handle_connect |
//                |                |
//                +----------------+
//                          :
// Once a connection is     :
// made, the connect        :
// actor forks in two -     :
//                          :
// an actor for reading     :       and an actor for
// inbound messages:        :       sending heartbeats:
//                          :
//  +------------+          :          +-------------+
//  |            |<- - - - -+- - - - ->|             |
//  | start_read |                     | start_write |<---+
//  |            |<---+                |             |    |
//  +------------+    |                +-------------+    | async_wait()
//          |         |                        |          |
//  async_- |    +-------------+       async_- |    +--------------+
//   read_- |    |             |       write() |    |              |
//  until() +--->| handle_read |               +--->| handle_write |
//               |             |                    |              |
//               +-------------+                    +--------------+
//
4

1 に答える 1

4

Visual Studio に統合されたものを見つけられるとは思えませんが、オンラインの ASCII フローチャート ジェネレーターであるAsciiFlowに興味があるかもしれません (コメントにコピーして貼り付けることができます)。

そうは言っても、そこにあるのは基本的にアーキテクチャのドキュメントです。この種の大まかなドキュメントは、(ほとんど) コメントの一部であってはなりません。コメントは短く、簡潔で、要点を絞ったものにする必要があります (特にチームで作業している場合)。詳細については、多くのリソースの 1 つを参照してください (ここで人気のあるリソースの 1 つはGoogle C++ スタイル ガイドです)。

フローチャートなどは、ソース ファイルの奥深くに埋め込まれていない、完全に人間が読める何らかの補助ドキュメント (設計ドキュメントや API ドキュメントなど) の一部として適しています。

于 2012-08-06T01:06:46.187 に答える