bash function comments

Here’s a good way to add comments to a Bash function.

############################################################
# Function    : calculate_average
# Description : Calculates the average of a list of numbers.
# Parameters  : List of numbers separated by spaces
# Returns     : The average value of the input numbers
############################################################
calculate_average() {
  ...
}

############################################################
# Function    : calculate_sum
# Description : Calculates the sum of a list of numbers.
# Parameters  : List of numbers separated by spaces
# Returns     : The sum value of the input numbers
############################################################
calculate_sum() {
  ...
}