inline-docs.md

   1 ---
   2 title: Inline documentation
   3 ---
   4
   5 * Ruby: rdoc
   6 * JavaScript: jsdoc
   7
   8 ### RDoc
   9
  10     # Gets a circle's area
  11     #
  12     # @example
  13     #
  14     #   area(3)
  15     #   #=> 28.27
  16     #
  17     # @param [Number] r The radius of the ricle
  18     # @return [true] If so
  19     #
  20     # == Definition lists
  21     #
  22     # list::  hi.
  23     # +foo+:: parameterized
  24     #
  25     # == Definition lists
  26     # [foo]   also
  27     # [bar]   like this
  28
  29 http://rdoc.rubyforge.org/RDoc/Markup.html
  30
  31 ### Jsdoc
  32
  33     /**
  34      * Ads numbers
  35      *
  36      * @this {Circle}
  37      * @param {Number} r The radius