Julia 1.0 Programming Complete Reference Guide

Documenting functions

Julia comes out of the box with powerful code-documenting features. The usage is straightforward—any string appearing at the top level, right before an object, will be interpreted as documentation (it's called a docstring). The docstring is interpreted as markdown, so we can use markup for rich formatting.

The documentation for the thermal_confort function could be as follow:

""" 
        thermal_confort(temperature, humidity; <keyword arguments>) Compute the thermal comfort index based on temperature and humidity. It can optionally take into account the age of the patient. Works for both Celsius and Fahrenheit.  # Examples: 
```julia-repl 
julia> thermal_confort(32, 78) 
12 
``` # Arguments - temperature: the current air temperature ...