4

我想知道什么工具可以在 Visual Studio 中生成这样的评论？特别是创建图表的能力，如下所示。

//
//  +---------------+
//  |               |
//  | 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 中的东西，但你可能对AsciiFlow感兴趣，这是一个在线 ASCII 流程图生成器（你可以在评论中复制粘贴）。

话虽如此，您所拥有的基本上是架构文档。这种粗略的文档应该（几乎）永远不会成为评论的一部分。评论应该简短、简洁和中肯（尤其是在团队中工作时）。有关更多信息，请阅读那里的众多资源之一（这里流行的资源之一是Google C++ 样式指南）。

流程图等更适合作为完全人类可读的某种辅助文档（如设计文档或 API 文档）的一部分——而不是深埋在源文件中。

于 2012-08-06T01:06:46.187 回答