• Want to receive the latest contracting news and advice straight to your inbox? Sign up to the ContractorUK newsletter here. Every sign up will also be entered into a draw to WIN £100 Amazon vouchers!

Documenting c# Classes

Spacecadet

Double Godlike!
Joined
Mar 22, 2006
Messages
12,451
Likes received
53
Thanks received
16
Location
Jupiter
Anyone got any tips - preferably outputting to word
Need something like

Abstract Class
-property
-property
-method
-method etc..
class - inherits abstract class
-property
-property
-method
-method etc..

etc etc etc
 
good summary of options here though the question in the link is a bit stupid itself.
 
Anyone got any tips - preferably outputting to word
Need something like

Abstract Class
-property
-property
-method
-method etc..
class - inherits abstract class
-property
-property
-method
-method etc..

etc etc etc

The best thing for this is Sandcastle.

I've used it in the past for almost the same same reasons as yourself. Be warned, though, that it's not the most "polished" utility, and will require that you've decorated your classes/functions with /// style xml comments and will also require you to craft some xslt files to style the output. Oh, and it's all command line-driven.
 
The best thing for this is Sandcastle.

I've used it in the past for almost the same same reasons as yourself. Be warned, though, that it's not the most "polished" utility, and will require that you've decorated your classes/functions with /// style xml comments and will also require you to craft some xslt files to style the output. Oh, and it's all command line-driven.

I've found this useful for processing the embedded XML doc and interfacing to sandcastle.

Sandcastle Help File Builder - Download: SHFB v1.9.3.0 Release
 

Advertisers

Back
Top