flow.
"Flow is a condition of deep, nearly meditative involvement." - Tom DeMarco

Using GhostDoc to Document the Properties of Structs

Friday, July 06, 2007 4:17 PM
Update: 7/10/07
Roland Wiegelt (creator of GhostDoc) was kind enough to leave a comment regarding this post.  Apparently this is a known issue in 2.1.0 that has since been resolved in 2.1.1.  Thanks for the update, Roland!

I'm a huge GhostDoc fan.  If you haven't used it before it's essentially an automated documentation generator for .NET code.  It's also an extremely solid and extensible little product.  Although I normally replace the auto-generated content with something more meaningful it's worth its weight in gold in just helping me create those tricky XML doc comments.

And it's totally free.

Anyway, today I noticed that it doesn't generate docs for properties of structs.  Here's the work around: simply change the struct to a class (temporarily) and then generate the docs for the properties.  This works fine and once you're done you can simply change the class back to a struct.

Hope this helps a few people out there.

Feedback

 re: Using GhostDoc to Document the Properties of Structs

Hi, I just came across your blog entry. Which version did you use? If it's 2.1.0, the effect you describe (no doc for properties of structs) sounds like something that could be caused by a bug that was fixed in 2.1.1. As a matter of fact, I wasn't able to reproduce the described behaviour with 2.1.1.
7/7/2007 7:27 AM | Roland

# re: Using GhostDoc to Document the Properties of Structs

Hi Roland,

Thanks for the info. It looks like that I am using 2.1, as a matter of fact. I'll be sure to upgrade soon.

Thanks again!
Jeremy 7/10/2007 9:41 AM | Jeremy

Post a comment





 

Please add 7 and 6 and type the answer here: