| Roland Weigelt's G h o s t D o c | ||||||
| Latest News | Forum | My Homepage | My Weblog | About... | Über... |
|
| <summary> GhostDoc is a free add-in for Visual Studio that automatically generates XML documentation comments for C#. Either by using existing documentation inherited from base classes or implemented interfaces, or by deducing comments from name and type of e.g. methods, properties or parameters. </summary> |
Download GhostDoc
GhostDoc versions can be installed side-by-side for different versions of Visual Studio (in different folders). License FAQ:
Links:
|
GhostDoc in the Media
|
Nothing special, just some replacement rules for overrides of ToString(),
Equals() and GetHashCode().
Download link and more info
in
this blog post.
P.S. Wow, I didn't expect that: The number of downloads in 2008 for all versions of GhostDoc combined is already at slightly above 60000.
I really would like to express how much I enjoy your gifts. After receiving only
7 gifts in the year 2007 (in contrast to more than 70000 downloads), I now
receive 3, sometimes 4 packages per month - that's really amazing!
Update 2008-08-28: Writing this entry had a noticeable effect - since
May, the number of gifts per month dropped to 0.3 per month...
Even though GhostDoc is intended for English documentation (and there are no plans for future versions to change that), Luca Tagliaferri from Italy has created an Italian configuration file for GhostDoc (2.1.3). While I cannot comment on the quality (non parlo l'italiano), I recommend checking it out here.
More info in this blog post.
More info in this blog post.
There's an issue with the side-by-side installation of the versions for 2005 and 2008. Installing GhostDoc for 2008 will prevent GhostDoc for 2005 from running and vice-versa. A real stupid mistake - shame on me, during testing I didn't have a virtual machine large enough to install both Visual Studio 2005 and 2008 on (and like most of you I didn't want to install a beta of VS2008 on a production system).
Fixing the problem is trivial, but getting this out the door without risking to break other things is not (as anybody who has ever shipped software knows ;-). I'll try to release a version 2.1.2 after the weekend.
More info in this blog post.
More info in this blog post.
Daniel Root sent me a VB.Net version of the demo project.
I started looking into VB.Net support for 2.1, but the first thing I had to do was to write VB.Net code (meh) that I knew I wouldn't have to write if I already had the translated sample code*. With only a few hours per week to spare, I can imagine many things that I prefer doing. So I decided to move work on VB.Net support behind other C# features (e.g. inherited documentation for events defined in interfaces).
_______________
*) What I'm talking about: In
this blog post on 05/28 I asked VB developers to help me (not a VB
dev by passion ;-) by translating the sample
code supplied with version 2.0.0 from C# to VB.Net. This code will be included
in a future version so VB devs have the same "out-of-the-box experience" like C#
devs, i.e. a demo project that they can play around with to try out GhostDoc. But more
importantly, the translated demo project will help me during the development of GhostDoc,
saving me some time.
What was supposed to be version 1.9.6 turned into a full-blown feature release; more info in this blog post.
A week of vacation ends today and even though the weather was fine (finally, some inline skating!) and I had a lot of other stuff to do, I managed to spend quite a bit of time on GhostDoc. I have a preview version ready that I will test "in real life" during the next days; if things go well, a release could be pretty soon. On the other hand, in order to save some time, I had to cut corners here and there (without compromising the internal architecture, it's just to what extent certain features work) and I now have to decide whether the result is "good enough" for a release.
Not much to report here. I'm still busy with many other things, especially things related to my .NET user group "Bonn-to-Code.Net" (member of INETA), but also preparing talks I'll give all over Germany in the next months. And then there's my work as a volunteer for the local basketball team (I developed the software that is controlling the video walls and I'm working on a new version). Anyway, at least I have managed to set up virtual machine running Vista and Visual Studio 2005 ;-)
My plans are to release a version 1.9.6 in the next weeks (months ?) that - along with fixing the small setup problems under Vista - will feature a couple of minor fixes and maybe some small additions to the default rules that come out of the box. No new rules in code, just new rules that are possible today using the built-in possibilities of custom rules. Honestly I'm slightly disappointed that even though GhostDoc has been downloaded over 30000 times since the beginning of 2006, I haven't received a single mail saying "hey, here's a custom rule I developed that may be of interest to others". Anyway, if you have some interesting rules, send them to me and I'll include them (with full credits of course).
