Flutter for Beginners

Library documentation

Another important piece of package documentation is on the Dart level. The consumer needs to know every available method, its arguments, and return types to know how to take the most from the library.

We will create library documentation in Dart APIs by adding documentation comments in libraries directives (see Chapter 2, Intermediate Dart Programming) with the /// syntax:

/// This is a doc comment and may be added to any member of a library.

This can be applied to library members as well, such as methods, variables, and classes. Even private members may have documentation comments that may be helpful for understanding different pieces of the library.

Check out the official tips for writing good documentation for your ...