我想知道什么工具可以在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 |
// | | | |
// +-------------+ +--------------+
//
答案 0 :(得分:4)
我怀疑你会发现在Visual Studio中集成的任何东西,但你可能对AsciiFlow感兴趣,这是一个在线ASCII流程图生成器(你可以在你的评论中复制粘贴)。
话虽如此,你所拥有的基本上是架构文档。这种广泛的文档应该(几乎)永远不会成为评论的一部分。评论应简明扼要,简明扼要(特别是如果在团队中工作)。欲了解更多信息,请阅读其中的众多资源之一(这里有一个受欢迎的资源是Google C++ Style Guide)。
流程图等更适合作为某种辅助文档(如设计文档或API文档)的一部分,这些文档完全是人类可读的 - 不会深埋在源文件中。