Roland Weigelt's GhostDoc Forum Index Roland Weigelt's GhostDoc
Support and Community Forum
 
  FAQFAQ    SearchSearch    MemberlistMemberlist    UsergroupsUsergroups    fchat fChat  RegisterRegister  
  ProfileProfile    Log in to check your private messages Log in to check your private messages    Log in Log in 

Commenting a class possible?

 
This forum is locked: you cannot post, reply to, or edit topics.   This topic is locked: you cannot edit posts or make replies.    Roland Weigelt's GhostDoc Forum Index -> Feedback
View previous topic :: View next topic  
Author Message
ianinspain



Joined: 16 Nov 2005
Posts: 1

PostPosted: Wed Nov 16, 2005 4:19 pm    Post subject: Commenting a class possible? Reply with quote

Hi there,

just found ghostdoc, its great! But i was wondering i can Document .. class constructors, methods etc etc..

But the class itself doesn't seem to allow me to i.e.

public class File
{

Right click on the File above doesn't give me the option to Document....

is it not normal practice to document the class i.e.

This class performs this bla bla bla

Any ideas, maybe i am doing something wrong?

Thanks

Ian
Back to top
View user's profile Send private message
RWeigelt
Site Admin


Joined: 19 Jul 2005
Posts: 345
Location: Bonn, Germany

PostPosted: Wed Nov 16, 2005 5:57 pm    Post subject: Re: Commenting a class possible? Reply with quote

Documentation for classes (and enums etc.) is not supported yet, but will come in a future version - but what GhostDoc can do will be somewhat limited to what can be extracted from the identifier names. So the example of a class "File" wouldn't produce much of actual documentation...
_________________
Roland
Back to top
View user's profile Send private message Visit poster's website
donnythebowler



Joined: 19 Jul 2006
Posts: 1

PostPosted: Wed Jul 19, 2006 5:34 pm    Post subject: Ahh, but the keystrokes it will save... Reply with quote

Additionally, GhostDoc can be configured to insert <remarks> instead of <summary> as is recommended by the C# documentation.
Back to top
View user's profile Send private message
RWeigelt
Site Admin


Joined: 19 Jul 2005
Posts: 345
Location: Bonn, Germany

PostPosted: Wed Jul 19, 2006 8:26 pm    Post subject: Re: Ahh, but the keystrokes it will save... Reply with quote

donnythebowler wrote:
Additionally, GhostDoc can be configured to insert <remarks> instead of <summary> as is recommended by the C# documentation.

I read about the recommendation to use <remarks> in certain places instead of <summary>, too. I don't remember the details, but I regarded this as a mistake in the docs.
The <summary> tag is definitely the tag to use to write a short summary of what a certain element does. The <remarks> tag is intended to provide additional information.
That's why the usage of tags will be kept the way it is now.
BTW if you want GhostDoc to include an (empty) <remarks> tag, take a look at custom texts (see the "Options" tab on the configuration dialog).
_________________
Roland
Back to top
View user's profile Send private message Visit poster's website
brianedow



Joined: 14 Sep 2006
Posts: 1
Location: Virginia, US

PostPosted: Thu Sep 14, 2006 8:29 pm    Post subject: Reply with quote

I must say, before I ask, that this is the great add-in. GREAT WORK! Okay, now that is out of the way. What are the chances of adding in the documentation for classes?

-Brian
Back to top
View user's profile Send private message MSN Messenger
RWeigelt
Site Admin


Joined: 19 Jul 2005
Posts: 345
Location: Bonn, Germany

PostPosted: Thu Sep 14, 2006 8:39 pm    Post subject: Reply with quote

brianedow wrote:
What are the chances of adding in the documentation for classes?

I'm in the process of learning WPF (my Petzold book arrived some days ago) and I doubt I'll have a new feature release of GhostDoc in the next months.

Regarding the documentation for classes: I'm using GhostDoc for my daily work but so far I haven't missed generation of documentation for classes -- the texts I write for the classes are usually nothing that could be generated automatically.

Nevertheless, I'm not saying that such a feature would be useless. Could you give me some examples where you could use it? I keep track of all feature requests, just in case I'm "recharged" to work on GhostDoc.
_________________
Roland
Back to top
View user's profile Send private message Visit poster's website
lorir-w



Joined: 30 Dec 2008
Posts: 2

PostPosted: Tue Dec 30, 2008 12:22 am    Post subject: Re: Ahh, but the keystrokes it will save... Reply with quote

RWeigelt wrote:
BTW if you want GhostDoc to include an (empty) <remarks> tag, take a look at custom texts (see the "Options" tab on the configuration dialog).


Love this tool! I had the same question about inserting <remarks> tags. Your suggestion to look at custom text on the Options tab works well.

I'm a tech writer who has been charged with providing comment prompts. So although I may not be able to identify a pattern for generating comments, being able to insert fixed text (custom prompt) and adding my own tags to any element would be very helpful.


Last edited by lorir-w on Tue Dec 30, 2008 12:44 am; edited 1 time in total
Back to top
View user's profile Send private message
Display posts from previous:   
This forum is locked: you cannot post, reply to, or edit topics.   This topic is locked: you cannot edit posts or make replies.    Roland Weigelt's GhostDoc Forum Index -> Feedback All times are GMT


Page 1 of 1

 
Jump to:  
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum