visualstudio评论生成工具

visual studio comment generate tool

本文关键字：工具评论 visualstudio 更新时间：2023-10-16

我想知道有什么工具可以在visualstudio中生成这样的评论？尤其是创建如下面所示注释的图表的能力。

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

我怀疑您是否能在Visual Studio中找到任何集成的东西，但您可能对AsciiFlow感兴趣，这是一个在线ASCII流程图生成器（您可以在评论中复制粘贴它）。

话虽如此，您所拥有的基本上是架构文档。这种宽泛的笔划文档不应该（几乎）成为注释的一部分。评论应简明扼要（尤其是在团队中工作时）。欲了解更多信息，请阅读众多资源中的一个（这里最受欢迎的资源之一是谷歌C++风格指南）。

Flow-charts等更适合作为某种辅助文档（如设计文档或API文档）的一部分，这些文档完全可供人阅读，而不是隐藏在源文件中。