How should annotations be formatted in code functions?

Annotations for functions in code should be clear, concise, and informative. They typically include:

• A brief description of the function's purpose.
• Description of parameters (if any), their types, and values.
• Description of the return value.
• Possible exceptions or errors that the function may throw.

An example in JavaScript using JSDoc:

/**
 * Calculates the sum of two numbers.
 * @param {number} a - The first number.
 * @param {number} b - The second number.
 * @returns {number} The sum of a and b.
 */
function sum(a, b) {
  return a + b;
}

In QA Automation, annotations may also include information about preconditions, expected results, and test steps, especially for test functions.