視覺工作室評論生成工具

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

Answer 1

我懷疑你會發現任何東西，在Visual Studio集成，但你可能在AsciiFlow感興趣，網上ASCII流程圖發生器（你可以複製粘貼在您的意見）。

說了那麼，你有什麼基本上是建築文檔。這種寬泛的文檔應該（幾乎）不會成爲評論的一部分。評論應該簡短，簡明扼要（特別是在團隊中工作時）。欲瞭解更多信息，閱讀其中的一個資源（這裏流行的其中一個是Google C++ Style Guide）。

流程圖等等更適合作爲某種類型的輔助文檔（如設計文檔或API文檔）的一部分，這些輔助文檔完全是人類可讀的，而不是深埋在源文件中。