GhostDoc is a Visual Studio extension that automatically generates XML documentation comments for methods and properties based on their type, parameters, name, and other contextual information.
I use VB and GhostDoc's most important feature to me is the integration with intellisense. You need to spend A LITTLE time documenting the Sub or Function (about a couple of minutes) but then when you start to use that Sub or Function in your code, all the information on what the parameters are and what the function does and what the return values are all appear just as they do for a standard VS function. This saves a lot of time as previously I would have to go back to the code of the Sub/Function to make sure I was getting the parameters correct.
I am sure there is more but this alone improves my productivity very significantly.
Thank you! You can translate the Pro version T4 templates to the language of your preference but not the Free version. The latter is using templates that are not as open and flexible as the T4 in Pro.
Just a note. Earlier it was free for commercial use. Now it is free for non-commercial use only. And no nofification about license change was sent. We've uninstalled it, untill full investigation of new license.
That is not quite true actually. The Free version has always been automatically licensed to individuals downloaded it but not the company they work for.
The same is still true now. Again, the Free product is licensed to the individuals who download it but not the company their work for. Which means they can use it at work but when it comes to support - the individual is eligible for support not the company. Also means that if multiple developers use GhostDoc Free within the team, each must download their own copy. I hope this makes sense.
Yes, absolutely! When your trial expires, there is "Extend Evaluation" link on the About screen. Alternatively you can email support at submain.com to request extension - include your name and product version number.
Very useful tool. Unfortunately it lacks the ability to inherit documentation from members of *generic* interfaces and sub classes at the moment, so the tool did not satisfy my needs completely. (Yes, this is a feature request :))
The lack of support for exceptions is a huge negative. This tool doesn't even have the most basic support for documenting exceptions that are explicitly thrown from a method.
Don't be fooled. The power of GhostDoc is not in the ability to "generate" meaningful comments but rather the ability to suck in existing documentation from overridden methods, interface implementations, etc. That's why this is in my top 2 favorite addins.
Strange fragment of license: (license is talking about license?)
TRIAL LICENSE
If the SOFTWARE PRODUCT has been provided to you under a time-limited trial license for evaluation or other purposes, your right to use the SOFTWARE PRODUCT ends after the time period specified in the trial.
Is it Trial?
Your license looks like this code:
string License()
{
if(License()=="Trial")
return "Trial";
return "Free";
}
StackOverflowException :)
Hi Daniel,
I understand your confusion by the fact that we use the same EULA for both Free and Pro versions of GhostDoc. In fact, all of our product EULAs are pretty much the same with minor exceptions.
The "If the SOFTWARE PRODUCT has been provided to you under a time-limited trial license for evaluation" part is distinguishing between the Pro (which is downloaded on the Trial basis until one purchases a license) and Free (which is free as in beer) and as such returns "false" under the If condition in the sentence above.
I hope this helps:
if (GhostDoc("Free") == "Trial")
return "False";
If I purchase a personal license for the pro version, can I install it on multiple machines if I am the only person using it? In this case one would be on my workstation, and the other on my home rig.
Sorry about the delay getting back to you - email notification from VS Gallery got caught by Junk mail filters.
Per GhostDoc EULA - http://submain.com/ghostdoc/EULA.aspx - you can use your license on up to 3 computers if you are the only person using it.
Thanks!
Hi Vincent,
Please make sure you are using the latest build of GhostDoc. If it is still crashing, please email log files to us at support at submain.com. If you have more questions, please email at the same address above.
Thanks!
When you get a chance please send us that log file. GhostDoc works in VS2012 fine, there could be some permissions issues in your particular Win8 setup which we'd need to see the log file to confirm and troubleshoot. Thanks!
After installing ghostdoc, I couldn't get the normal menu items to show or even the keyboard short-cuts for ghost-doc. After a lot of testing I found that if I am logged in as my admin user, then I can see the menu items, but as a normal user then I don't? This is a problem since I don't want to be logged in as administrator every-time I do some programming. Any tricks I can use to get it to work for all my users on my computer? I tried copying some config file between user profiles but did not have time to play with all the permutations.
I see there is a pro version, not sure why anyone would want to pay for a product that don't show up in the menu items unless you're logged in as administrator.
I'd recommend that you spend time and money on a different product since the support is almost as good as the product itself. (Does not appear to be anywhere)
Hello,
GhostDoc runs under the same user you installed it.
If you need help or have questions, we will be happy to assist you though our support channels - forum on our site or customer-service at submain.com email address.
Thanks!
I was hoping that it was a simple case of a bad installer that only allow a tool to work on the installed user, however one of the first thing I did when I found this problem was to give my user admin rights, re-installed it and it still did not work.
I am sorry I had to post here, but just like the tool itself, your website was down. I am sure you will find that at the time I posted the first question here (around Sun 9:11 pm) your web admin logs should inform you that your web site with all its forums and help was down.
Not sure if it will be worth the time to re-post your tool's bugs here since you have read read this, not sure if this will help though.
Why does the version here only specify C# while the one on the SubMain/GhostDoc site available for VB.NET as well?
Is there a difference between the two installs, or does the description just not state it works for VB.NET here?
Christina,
GhostDoc on SubMain web site is the same as the one listed here (only newer version) and it does support VB.NET.
The Gallery page is still owned by Roland (the original GhostDoc author) and we can't update it when we have new version.
Free
View Large
