| View previous topic :: View next topic |
| Author |
Message |
ianinspain
Joined: 16 Nov 2005 Posts: 1
|
Posted: Wed Nov 16, 2005 4:19 pm Post subject: Commenting a class possible? |
|
|
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 |
|
 |
RWeigelt Site Admin
Joined: 19 Jul 2005 Posts: 345 Location: Bonn, Germany
|
Posted: Wed Nov 16, 2005 5:57 pm Post subject: Re: Commenting a class possible? |
|
|
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 |
|
 |
donnythebowler
Joined: 19 Jul 2006 Posts: 1
|
Posted: Wed Jul 19, 2006 5:34 pm Post subject: Ahh, but the keystrokes it will save... |
|
|
| Additionally, GhostDoc can be configured to insert <remarks> instead of <summary> as is recommended by the C# documentation. |
|
| Back to top |
|
 |
RWeigelt Site Admin
Joined: 19 Jul 2005 Posts: 345 Location: Bonn, Germany
|
Posted: Wed Jul 19, 2006 8:26 pm Post subject: Re: Ahh, but the keystrokes it will save... |
|
|
| 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 |
|
 |
brianedow
Joined: 14 Sep 2006 Posts: 1 Location: Virginia, US
|
Posted: Thu Sep 14, 2006 8:29 pm Post subject: |
|
|
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 |
|
 |
RWeigelt Site Admin
Joined: 19 Jul 2005 Posts: 345 Location: Bonn, Germany
|
Posted: Thu Sep 14, 2006 8:39 pm Post subject: |
|
|
| 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 |
|
 |
lorir-w
Joined: 30 Dec 2008 Posts: 2
|
Posted: Tue Dec 30, 2008 12:22 am Post subject: Re: Ahh, but the keystrokes it will save... |
|
|
| 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 |
|
 |
|