Introduction

As part of the strategy for tackling the challenges of the software crisis, good programming practice came to include writing clear documentation to support both the end-users who will utilize your programs, as well as other programmers (and yourself) in understanding what that code is doing so that it is easy to maintain and improve.

Key Terms

Some key terms to learn in this chapter are:

  • User documentation
  • Developer documentation
  • Markdown
  • XML
  • Autodoc tools
  • Intellisense

Key Skills

The key skill to learn in this chapter is how to use C# XML code comments to document the C# code you write.