CHAPTER 11

image

The Dart Comment System

In this chapter we will cover the Dart comment systemthe different types of comments available when you write your Dart code. We’ll see inline, block, and documentation comments and how to use them to properly document your applications. In addition, at the end of the chapter we’ll see the markdown syntax you would use to add extra functionality to your programs’ documentation.

Comments Overview

As you know, comments are an essential part of the source code of any application. They help to clarify some tricky parts of the code, especially if you have to return to them later to change anything.

They also help ...

Get Web Programming with Dart now with the O’Reilly learning platform.

O’Reilly members experience live online training, plus books, videos, and digital content from nearly 200 publishers.