News for hackers. Stuff that matters.
Re:ASCII Art in .NET Code by userbinator on Tuesday July 09, 2019 @11:32PM (#20398964)
Comments like this are often discouraged because they're difficult to modify when the code is changed, but in these cases it seems their purpose besides explanation is to imply that there is a good reason the code is the way it is, and that you had better have a very good reason to change the code (and the accompanying comment). In other words, they serve to also guard against change, in parts of the code which should not change often.
Re:ASCII Art in .NET Code by ken on Wednesday July 10, 2019 @01:47AM (#20399421)
Most of these diagrams don't look that difficult to modify -- but then, I've got Emacs (with picture-mode, artist-mode, table-mode, etc). The presence of a diagram would not discourage me from changing a function, if I thought it needed changing. I wish most functions were so well documented!

It's true I haven't seen any IDEs with similar capabilities, so I imagine it is harder for other people. At what point does it become permissible to say "It's not my problem you choose to use a text editor that isn't capable of editing this style of text"? We're certainly well beyond that point in most other areas, e.g., indentation, capitalization, or renaming.

Re:ASCII Art in .NET Code by matthewwarren on Wednesday July 10, 2019 @07:08AM (#20400825)
> but in these cases it seems their purpose besides explanation is to imply that there is a good reason the code is the way it is, and that you had better have a very good reason to change the code (and the accompanying comment). In other words, they serve to also guard against change, in parts of the code which should not change often.

Interesting, I'd not thought about that 'side-effect', but you're right, it does guard against that