Home/ Questions/Q 8335065
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Asked: 2026-06-09T03:33:07+00:00

I wonder what tool could generate comment like this in visual studio? Especially the

  • 0

I wonder what tool could generate comment like this in visual studio? Especially the capability of create the diagram like the comment shown at below.

//
//  +---------------+
//  |               |
//  | 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 |
//               |             |                    |              |
//               +-------------+                    +--------------+
//
Share

Leave an answer

You must login to add an answer.

Need An Account,

1 Answer

  1. Editorial Team

    I doubt you’ll find anything that integrates in Visual Studio, but you may be interested in AsciiFlow, an online ASCII flow-chart generator (that you can copy-paste in your comments).

    With that said, what you have up there is essentially architectural documentation. This kind of broad-stroke documentation should (almost) never be a part of comments. Comments should be brief, concise and to the point (especially if working in a team). For more information read one of the many resources out there (one of the popular ones around here is the Google C++ Style Guide).

    Flow-charts and the like are much better suited as a part of some sort of auxiliary documentation (like a design document or an API documentation) that is wholly human-readable – not buried deep in source files.

    • 0