The most effective way to document .NET code so that others can understand it and use it, is to use XML Documentation and Sandcastle. It isn't that easy. Michael Sirens produces the easy guide to the process that Microsoft never managed, and introduces several applications that help.
Read more: Greg's Cool [Insert Clever Name] of the Day
Contents
- XML Documentation Comments: First Look.
- Doc-Comment Elements.
- Automate Your Doc-Comment Creation.
- The Problem of Documentation Generation.
- Sandcastle Help File Builder
- Running Sandcastle Help File Builder
- Sandcastle Help File Builder Configuration: First Look.
- Rules for Embedding HTML..
- Sandcastle for NDoc Users.
- Sandcastle Considerations.
- Browser Flexibility.
- Storage Requirements.
- Performance and Inheritance.
- Issues Deploying on Linux/Unix.
- Disambiguating and Resolving <see> References.
- Verbosity of <see> Elements.
- Referencing Generic Types in <see> Elements.
- Displaying Sample Code.
- Style Choices and Code Display Issues.
- Using Favicons in Your Generated Web Site.
- Rendering Issue with Unresolved Links.
- File Naming Conventions.
- Specifying Debug or Release Configuration.
- Finding What You Missed.
- Documenting Namespaces.
- Conclusion.
Read more: Greg's Cool [Insert Clever Name] of the Day