I need a documentation writing tool.
-
I just finished porting my C++ classes over to C# and now I want to document everything. In other words, I want to put the usual /// comments on top of every class and public member. I've started doing it manually, but it seems to me like there ought to be an easier way. I mean, it's a pain to have to write out the opening and closing tags for the summary, params, remarks, etc. So I'm wondering if there's a tool out there that can scan a .cs file, list all the public classes and members in a tree pane (on the left) and allow me to fill in the appropriate doc sections (on the right). This would allow me finish my task sooner, more accurately, and with less typing. Anyone know of something like this, of should I start thinking about creating one? Thanks, Alvaro
When birds fly in the right formation, they need only exert half the effort. Even in nature, teamwork results in collective laziness. -- despair.com
-
I just finished porting my C++ classes over to C# and now I want to document everything. In other words, I want to put the usual /// comments on top of every class and public member. I've started doing it manually, but it seems to me like there ought to be an easier way. I mean, it's a pain to have to write out the opening and closing tags for the summary, params, remarks, etc. So I'm wondering if there's a tool out there that can scan a .cs file, list all the public classes and members in a tree pane (on the left) and allow me to fill in the appropriate doc sections (on the right). This would allow me finish my task sooner, more accurately, and with less typing. Anyone know of something like this, of should I start thinking about creating one? Thanks, Alvaro
When birds fly in the right formation, they need only exert half the effort. Even in nature, teamwork results in collective laziness. -- despair.com
Alvaro Mendez wrote: should I start thinking about creating one? :) You could do that and then post it as an article...it would be very nice to have. Meanwhile, I'll ask around.
Hawaian shirts and shorts work too in Summer. People assume you're either a complete nut (in which case not a worthy target) or so damn good you don't need to worry about camouflage... -Anna-Jayne Metcalfe on Paintballing
-
I just finished porting my C++ classes over to C# and now I want to document everything. In other words, I want to put the usual /// comments on top of every class and public member. I've started doing it manually, but it seems to me like there ought to be an easier way. I mean, it's a pain to have to write out the opening and closing tags for the summary, params, remarks, etc. So I'm wondering if there's a tool out there that can scan a .cs file, list all the public classes and members in a tree pane (on the left) and allow me to fill in the appropriate doc sections (on the right). This would allow me finish my task sooner, more accurately, and with less typing. Anyone know of something like this, of should I start thinking about creating one? Thanks, Alvaro
When birds fly in the right formation, they need only exert half the effort. Even in nature, teamwork results in collective laziness. -- despair.com
-
I just finished porting my C++ classes over to C# and now I want to document everything. In other words, I want to put the usual /// comments on top of every class and public member. I've started doing it manually, but it seems to me like there ought to be an easier way. I mean, it's a pain to have to write out the opening and closing tags for the summary, params, remarks, etc. So I'm wondering if there's a tool out there that can scan a .cs file, list all the public classes and members in a tree pane (on the left) and allow me to fill in the appropriate doc sections (on the right). This would allow me finish my task sooner, more accurately, and with less typing. Anyone know of something like this, of should I start thinking about creating one? Thanks, Alvaro
When birds fly in the right formation, they need only exert half the effort. Even in nature, teamwork results in collective laziness. -- despair.com
-
You can try doxygen. Its rather flexable. :) I rated this article 2 by mistake. It deserves more. I wanted to get to the second page... - vjedlicka 3:33 25 Nov '02
-
I just finished porting my C++ classes over to C# and now I want to document everything. In other words, I want to put the usual /// comments on top of every class and public member. I've started doing it manually, but it seems to me like there ought to be an easier way. I mean, it's a pain to have to write out the opening and closing tags for the summary, params, remarks, etc. So I'm wondering if there's a tool out there that can scan a .cs file, list all the public classes and members in a tree pane (on the left) and allow me to fill in the appropriate doc sections (on the right). This would allow me finish my task sooner, more accurately, and with less typing. Anyone know of something like this, of should I start thinking about creating one? Thanks, Alvaro
When birds fly in the right formation, they need only exert half the effort. Even in nature, teamwork results in collective laziness. -- despair.com