Class Documentation Templates

[irasmith]

I was wondering if anyone could point me to either some on-line resources or provide book title(s) that have templates or examples of ways to document the classes in a program?

 

I realize that there is no one 'supreme' template that will provide everything I need and want, but a template gives me a good place to start my documentation as I work on the project. I have the Software Requirements book by Karl Wiegers which deals with documenting the requirements and such, and there are very good templates with it that I have used and modified somewhat to fit my needs. I'm not at the point where I'm starting to lay out the classes, methods, and properties and would like to follow current practices of documenting those as well. Any suggestions or resources that you could point me to would be greatly appreciated.

[Diesel]

Class Diagrams using UML.

 

Lots of UML books on amazon.

[irasmith]

Thanks for the suggestion. I had not looked into UML too much at this point but will check into it some more. :)

[Nerseus]

Try downloading the new Visual Studio beta as well (or an Express version) - they do full forward/reverse engineering with UML models, all built right into VS.

 

-ner

[irasmith]

Thanks for the suggestion. I looked at the information on line and that is going to be one very nice feature to have when it is officially released and I start using it

:)

 

 

For the meantime though I'll have to do things the manual way. The project I'm invovled with is in .NET 1.1 and of course I am sure there will be some things we have to do at a point to get it up to .NET 2.0.