Self-documenting code is a goal for so many developers. Using XML code comments helps make that goal a reality. Learn how to add documentation to every type member. Once that is finished, sit back and enjoy using the type and watch IntelliSense show that help information in the IDE.
- View Offline
- Exercise Files
- Self-documenting code is a goal for so many developers.…We strive to write code that is easy to read,…follows good design patterns, and is logical and sane.…But we don't write all the code that we consume.…So how do you know the best way to use other people's code?…If you have access to the source code,…you can open a function definition…and see how it's written and how its parameters are used.…But the reality is, much of the code…that we use is stored in compiled assemblies…where we don't get that level of detail.…
The solution to this dilemma is to write code documentation.…In the old days, we'd put it in big manuals…that gathered dust on the top shelf of your office bookcase.…Nowadays we put it on websites.…An even better choice is when we can put the documentation…in the compiled assembly and show it in the code editor.…In the .NET world, that is accomplished with XML comments.…And that, my friends, is what we are going to look at today.…I'll start by looking inside the Program.cs file.…On line 9, I'm using one of the types…
- Exploring the code editor window and default settings
- Commenting code
- Using hover tips and IntelliSense
- Tracking changes
- Refactoring code
- Formatting and arranging code
- Navigating and inspecting code
- Using the Task List
- Working with snippets and smart tags
Skill Level Beginner
ASP.NET MVC 5 Essential Trainingwith Michael Sullivan3h 40m Intermediate
1. Work with Code Editors
2. Format Your Code
3. Navigate and Inspect Code
4. Tools for Enhancing Your Coding Sessions
- Mark as unwatched
- Mark all as unwatched
Are you sure you want to mark all the videos in this course as unwatched?
This will not affect your course history, your reports, or your certificates of completion for this course.Cancel
Take notes with your new membership!
Type in the entry box, then click Enter to save your note.
1:30Press on any video thumbnail to jump immediately to the timecode shown.
Notes are saved with you account but can also be exported as plain text, MS Word, PDF, Google Doc, or Evernote.