我想知道什么工具可以在 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 |
// | | | |
// +-------------+ +--------------+
//
最佳答案
我怀疑您会发现任何集成在 Visual Studio 中的东西,但您可能对 AsciiFlow 感兴趣,这是一个在线 ASCII 流程图生成器(您可以在评论中复制粘贴)。
话虽如此,您所拥有的本质上是架构文档。这种宽泛的文档应该(几乎)永远不会成为评论的一部分。评论应该简短、简明且中肯(尤其是在团队中工作时)。有关更多信息,请阅读众多资源之一(这里最受欢迎的资源之一是 Google C++ Style Guide )。
流程图等更适合作为某种完全可读的辅助文档(如设计文档或 API 文档)的一部分,而不是深埋在源文件中。
关于c++ - Visual Studio 评论生成工具,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/11821450/