The VSORCAS Documentation Format
It appears I was slightly mistaken about what the new VSORCAS documentation format in Sandcastle actually is. It's actually a new "front end" to the documentation and for now is restricted just to documentation produced by Sandcastle itself (see the comment in my previous blog post).
Anyway a new Sandcastle CTP has just been released and the new "VSORCAS" (bad name) output format is included.
Here's what it looks like (click for larger image):
The use of tabs to only show specific syntaxes is quite nice and saves a fair bit of real estate. And the in line filtering of contents based on properties (private, public, etc) is useful when you have a large class you are looking at
Here's a filtered view of the same class
Sandcastle also handles Generics quite nicely now as well, as can been seen in this method's documentation.
While the documentation shown so far is HTML output, you also get the HxS output as well as CHM output, all of which exhibit the same behaviour. Here's a shot of the CHM output.
Sandcastle is progressing nicely now, and appears to be a viable replacement to NDoc. It still needs more work (especially a GUI front end) but it's making good progress.
Oh, I should also mention that there is another new format called "prototype" that acts much the same as the vsorcas format, but has a cleaner look and feel as shown here:
Anyway a new Sandcastle CTP has just been released and the new "VSORCAS" (bad name) output format is included.
Here's what it looks like (click for larger image):
The use of tabs to only show specific syntaxes is quite nice and saves a fair bit of real estate. And the in line filtering of contents based on properties (private, public, etc) is useful when you have a large class you are looking at
Here's a filtered view of the same class
Sandcastle also handles Generics quite nicely now as well, as can been seen in this method's documentation.
While the documentation shown so far is HTML output, you also get the HxS output as well as CHM output, all of which exhibit the same behaviour. Here's a shot of the CHM output.
Sandcastle is progressing nicely now, and appears to be a viable replacement to NDoc. It still needs more work (especially a GUI front end) but it's making good progress.
Oh, I should also mention that there is another new format called "prototype" that acts much the same as the vsorcas format, but has a cleaner look and feel as shown here: