From annoyance to laugher in two seconds
This is a screen shot from NDepend (I have a review forthcoming), I run it on a code base, and I went through the issues it found.
These rules are things that I disagree with.
So I clicked to modify it, and I got this, which had me laughing.
I like the spirit.
Comments
I put in a fix on some code many year back and it wasn't pretty, I did add comments along the lines "this code is a mess but it has to go in urgently - sorry in advance".
A couple of years later a developer came to me saying he was maintaining that same bit of code. Reading the comments and understanding my frame of mind actually made it easier for him to understand what was going on.
About 15 years ago I was working on a PICK system. I found some code with the following comment -
"Just a bloody comma - ignore it."
I don't know, I'm still pretty annoyed :)
What tool do you use for your diagrams? Those are some pretty looking boxes and arrows :)
That's good documentation!
It's a lovely tool , very customizable, and it has learned a lot throughout the past 9 months. The ability e.g. to mark classes with attributes for means of performing specific code analysis on those types didn't exist end of last year. Let's see how far it goes.
Comment preview