Visual Studio Comment Creation Tool

Question

I wonder what tool can generate such a comment in visual studio? Especially the ability to create a chart, like the comment shown below.

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

I doubt that you will find anything that integrates with Visual Studio, but you might be interested in AsciiFlow , an ASCII online stream, chart generator (which you can copy-paste into your comments).

Given the above, that you have, in essence, architectural documentation there. Such large-format documentation should (almost) never be part of the commentary. Comments should be concise, concise and accurate (especially if they work in a team). For more information, read one of the many resources (one of the popular here is the Google C ++ Style Guide ).

Technological diagrams, etc. are much better suited as part of supporting documentation (such as a project document or API documentation) that is fully human-readable - it doesn’t dig deep into the source files.