In this recipe, we will be using the @moduledoc and @doc reserved module attributes to add documentation to the modules we defined in the previous recipe, Enforcing behaviors.
Open the randomizer.ex and my_module.ex files created in the Enforcing behaviors recipe inside your preferred code editor.
To add documentation to our modules, follow these steps:
We will start by adding module documentation to the
randomizer.exfile. Add the following code below theuse Behaviorline:@moduledoc """ This module specifies the interface for a randomizer behaviour by using the defcallback macro. """
Add the following module documentation to the
my_module.exfile below the@behaviour Randomizerline:@moduledoc """ This is a custom module to demo the implementation of behaviours. """
To document the
randomizefunction insidemy_module.ex, insert the following code right above the function definition:@doc """ The randomize callback defines the randomize function...