Doc comments

[kyleect]

Syntax

;; Add two numbers together
;;
;; @type {procedure}
;; @param {number} a First number to add
;; @param {number} b Second number to add
;; @returns {number} Result of adding numbers
(define add (lambda (a b) (+ a b)))

or

(define add
  ;; Add two numbers together
  ;;
  ;; @type {procedure}
  ;; @param {number} a First number to add
  ;; @param {number} b Second number to add
  ;; @returns {number} Result of adding numbers
  (lambda (a b) (+ a b)))

or

(define add
  "
  Add two numbers together
  
  @type {procedure}
  @param {number} a First number to add
  @param {number} b Second number to add
  @returns {number} Result of adding numbers
  "
  (lambda (a b) (+ a b)))

Questions

• First class doc comments? (doc sum) ==> "Add two numbers...