From the course: C# Framework Design
Join today to access over 24,900 courses taught by industry experts.
Document a framework - C# Tutorial
From the course: C# Framework Design
Document a framework
- [Instructor] Framework adoption is made or broken based on how well it's documented. If developers don't know how to use your framework, chances are they won't. At a high level, any public API should be documented. C# frameworks use XML-style commenting. This is actually built into Visual Studio itself. Simply type three forward slashes above a class or method you want to comment and an XML template will be generated. Here you can see the My class example from earlier and a summary node has automatically been generated with text inside that says My class. You can add as much text as you want in between the open and closed nodes. When it comes to methods, especially those that return values or accept values, the common template will automatically include those when it gets generated. So here we have a load method and I typed out three forward slashes and Visual Studio automatically created a summary, a return, and the…
Download courses and learn on the go
Watch courses on your mobile device without an internet connection. Download courses using your iOS or Android LinkedIn Learning app.