Re:Programming with proportional fonts is great
by Deestan on Saturday January 16, 2010 @09:01AM
(#1056914)
Design documents and complex diagrams don't belong in code, but a simple ASCII diagram right there in the code to illustrate how the transformation tree is created:
- is always within easy reach of the eye.
- is harder to forget about when changing the code.
- doesn't require you to download, install, register and fire up Visio Community Edition 2008 to add a new FileLogger node to the illustration of the data transformation tree.
Re:Programming with proportional fonts is great
by nailer on Saturday January 16, 2010 @03:28PM
(#1057429)
Simple and complex diagrams can be made in any decent graphics app (Inkscape or Keynote are fantastic) and easily exported to PNG or SVG.
Personally I also have a lot of trouble reading ASCII diagrams. Knowing that pipe-slash-dash is a curved line, when the line is broken and the ends don't line up properly.
On a separate note, I suggest whoever moderated me to zero should read the HN guidelines.
That actually makes me support the idea of using proportional fonts even more.
- If something's that complex you need a diagram to support it, that probably doesn't belong in your code - you should maintain documentation in documentation format, and doc updates shouldn't mean new code revisions. Throw a URL to the documentation in as the comment.
- Diagrams could be illustrated much better with an actual diagram rather than an ASCII visualization of one.