language-agnostic - ASCII图值得我花时间吗？

Question

源代码中的ASCII图是否值得花时间创建？

我可以更快地创建位图图，但是很难在源文件（until VS2010）中插入图像。

作为记录，我不是在谈论decorative ASCII art。

这是我最近为我的代码创建的一个图表示例，我可能可以在一半时间内用MS Paint构造它。

          Scenario A:

                          v
 (U)____________(N)_______<--(P)                   Legend:
          '     /             |                    J = ...
          '    /              |                    P = ...
          '   /d              |                    U = ...
          '  /                |                    v = ...
          ' /                 |                    d = ...
          '/                  |                    N = ...
         (J)                  |
          |                   |
          |___________________|

Answer 1

如果使用工具从代码中生成文档，例如Doxygen，则应该有一种直接引用图像文件并将其显示在生成的文档中的方法。对于Doxygen，相关命令为\image。这结合了具有实际图像图的优点以及易于从源中进行引用的优点（无需启动诸如Word之类的繁重程序），还可以与自动生成的文档一起使用。