@doc
Only valid: inside @goal
.
Provides a description for a goal.
Example Makesurefile
:
@goal build
@doc builds the project
echo "Building ..."
@goal test
@doc tests the project
echo "Testing ..."
Running ./makesure -l
will show
Available goals:
build : builds the project
test : tests the project