You can follow the posts in this thread, but I know a *lot* of people are anxiously awaiting the release of Microsoft Sandcastle. Sandcastle is the codename for Microsoft’s NDoc like documentation compiler.
I have spoken with people from Microsoft ever since .NET 2.0 came out about what tool they use to do their documentation. We were having issues with NDoc 1.3 and generics and needed a solution. Kevin Downs was kind enough to send me alpha releases of NDoc2, the next generation of NDoc, which fixed the issues with generics.
From comments by Anand Raman, The CTP release will not include and MSBuild tasks. I wish I could have been on beta testing list for this because then I could have had the MSBuild tasks built and ready for the CTP release.
I am curious if it will be possible to integrate the output from Sandcastle with Innovasys Help Studio Lite, which ships (free) with the Visual Studio 2005 SDK. That would be cool because then we could have an integrated documentation release that included a getting started guide and SDK docs.
From other posts and forums I am able to get a little more info about it:
[via Andrew Stopford]
- Produces quality, comprehensive, familiar MSDN-like documentation.
- Works with or without authored comments.
- Supports Generics and .NET Framework 2.0
- Sandcastle has 2 main components (MrefBuilder and Build Assembler)
- MrefBuilder generates reflection xml file for Build Assembler
- Build Assembler includes syntax generation, transformation..etc
- Sandcastle is used internally to build .Net Framework documentation
- MS plan to "..include Sandcastle in our August CTP release of VS SDK."
[via Michael Primeaux]
Sandcastle generates documentation using the following overall process:
- Use the /doc compiler option to generate an XML documentation file.
- Run the assemblies through Sandcastle (MRefBuilder, XslTransform, and BuildAssembler) to produce a set of HTML files.
- Use the Microsoft HTML Help Compiler. The help compiler version 1.0 is used to produce CHM files and version 2.0 is used to generate HXS files.
- Brenton House - Give your Titanium App a Turbo Boost – Part 2
- Easily Enable Speech Recognition in Titanium iOS using Hyperloop
- Error creating new MVC Controller for Entity Framework
- Google introduces the Knowledge Graph
- Basic WCF Authentication with SQL Membership Provider
- Frequently Asked Questions about Free Upgrade on SkyDrive
- Microsoft Cloud services are changing... Windows Live is dead. Long live SkyDrive.
- Microsoft SkyDrive has received a major upgrade!
- Using Windows 8 and Visual Studio 11 Together
- Installing latest Windows 7 updates could cause unbootable system
- Activating Windows 7 on different hardware
- Avoid creating hidden 200MB partition in Windows 7
- How to get your Quick Launch Toolbar back in Windows 7
- How to find missing drivers for Windows 7
- How to (Successfully) Install Cisco VPN Client on Windows 7
- Brenton House
- Cisco VPN
- Community News
- Continuous Integration
- Free Stuff
- General Software Development
- Google Drive
- Live Mesh
- Mac OS X
- Other Stuff
- Team Systems
- titanium mobile
- titanium native
- titanium turbo
- Unit Testing
- Visual Studio
- Visual Studio 11
- Windows 7
- Windows 8
- windows update