Question

I am currently writing a Bash script that has a number of functions in it and would like to add docs to make other team members understand what the point of the function is.

Is there a standard “style” for documenting Bash scripts and the functions it contains?

Answer 1

Usually, I try to follow guidelines that are analog to the ones I use with other languages like C.

This includes a function header containing:

• function name, short description and purpose
• list of arguments and return values, with descriptions
• list of all side effects (e.g., changes in variables or files)