Visual Studio评论生成工具

Question

我想知道在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 |
//               |             |                    |              |
//               +-------------+                    +--------------+
//

- Bryan Fok

Answer 1

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

话虽如此，您所拥有的基本上是架构文档。这种广泛的文档（几乎）永远不应该成为注释的一部分。注释应该简洁明了，简明扼要（特别是在团队中工作时）。有关更多信息，请阅读众多资源之一（其中一种流行的资源是Google C++ Style Guide）。

流程图等更适合作为某种辅助文档（例如设计文件或API文档）的一部分，这些文档完全可读性强 - 不深埋在源文件中。

- David Titarenco

---

我不会向我的最坏的敌人推荐Google C++风格指南。并不是说里面没有更糟糕的东西，而是其中一些建议非常特定于Google（避免异常，因此避免在构造函数中工作等），对于新手来说很难理解该保留什么和该丢弃什么... - Matthieu M.

我主要是推荐风格指南的评论部分（因此有#comments锚点）--我认为无论你使用哪种编程语言，这都是一个很好的资源。我同意其他部分可能过于具体化。 - David Titarenco