When GhostDoc Fails...

Published 22 March 05 10:20 AM | mhawley

Since pictures are worth a thousand words…

AlreadyScheduled

As you can see, GhostDoc isn’t 100% accurate on creating decent documentation.

Update – here’s a better one that really makes me chuckle…

ToString

Comments

# Derick Bailey said on March 22, 2005 02:27 PM:

You should send this over to www.TheDailyWTF.com :)

# Matt Hawley said on March 22, 2005 02:29 PM:

Nah, not funny enough. Just enough for a chuckle.

# Roland Weigelt said on March 22, 2005 04:52 PM:

In fact, "Toes the string" is a running gag with the guys at work ;-)

Very common methods like "ToString()" or "Equals()" will be handled in a more intelligent way in a future version.

Regarding "AlreadyScheduled": This is a case where a rule *would* be possible, but a different naming of the method could even be better; I'd call it "IsAlreadyScheduled()". One advantage: If you have several methods that check a state, you'll find them all in one place when using intellisense. Another advantage: GhostDoc knows how to handle methods starting with "Is..." or "Has..." ;-)

Roland

# Matt Hawley said on March 22, 2005 04:54 PM:

Thanks Roland, I figured I could have made the architecure better, but I'm just documenting and don't want to change the code base.

Good to see "Toes the string" is a gag for you as well :)

# Scott said on March 30, 2005 04:56 PM:

My favorite is still "Ons the Init". I spend a lot of time oning my init.

This Blog

News

.NET Links

Blogs I Read

Syndication