How can one tell GhostDoc to NOT comment exceptions thrown by a given method?
Question asked by Mark Kamoski - February 26 at 7:59 AM
Answered
GhostDoc Users,
 
Please help.
 
How can one tell GhostDoc to NOT comment exceptions thrown by a given method?
 
Please advise.
 
I use "Document This" at the method level a lot, but, I do NOT want GhostDoc to add comments for exceptions thrown by the method, as it is bulks up the documentation a lot.
 
Is there a way to turn off exception-commenting in GhostDoc?
 
Please advise.
 
Thanks.
 
-- Mark Kamoski

3 Replies

Reply to Thread
0
Serge B. Replied
Employee Post Marked As Answer
Hi Mark,
 
Yes, you can turn exceptions off In GhostDoc Pro. 
 
In Options -> Rules -> Method find the following line 
if(Context.HasExceptions)
and change it to 
if(Context.HasExceptions && false)
Thanks!
Serge Baranovsky
SubMain Software
(800) 936-2134
0
Mark Kamoski Replied
Serge,

I appreciate the answer but, please, I need a bit more help.

Where exactly do I find the following line...

if(Context.HasException)

...in the latest GhostDoc Community edition?

I am using Visual Studio 2015.

I go to > Tools, > GhostDoc, > Options, > GhostDoc, > Rules, > Methods, and I see the rules list...

int GetHashCode()
bool Equals(object obj)
string ToString()
...
Last word triggers "of the" reordering
Default documentation

...and I selected each in turn, clicking the Edit button for each, and looked for the line "if(Context.HasException)" but could not find it, so...

....where can I find the line "if(Context.HasException)" here?

Please advise.

Thanks.

-- Mark Kamoski
0
Serge B. Replied
Employee Post
My apologies, Mark. I meant to say above this only works in GhostDoc Pro and GhostDoc Enterprise - both of these use T4 templated rules while GhostDoc Community historically has a completely different type of rule configuration.

Our records show that you do have GHostDoc Pro license.

You can retrieve all your past and current licenses using your Gmail address at https://submain.com/MyAccount/
Serge Baranovsky
SubMain Software
(800) 936-2134

Reply to Thread