079 RR Documenting Code

    0
    456

    01:58 – Ruby Nuby

    02:37 – Best of Parley

    03:51 – Documenting Code 05:29 – Comments

    • rdoc
    • Internal/External Documentation
    • “A comment is a lie waiting to happen”
    • comment 😉

    10:36 – Tests

    20:15 – Inline comments

    27:12 – rdoc

    41:24 – Integrated Documentation 47:01 – README

    52:23 – Class-responsibility-collaboration cards

    55:52 – Rails Guides

    Podcast Awards

    Next Week

    • Practical Metaprogramming with Steven Harms

    Book Club

    The next Ruby Rogues Book Club Pick will be Practical Object-Oriented Design in Ruby: An Agile Primer by Sandi Metz. We will be interviewing Sandi on January 2, 2013, with the episode airing January 9, 2013. The publisher, Pearson/Addison-Wesley is offering a discount via InformIT.com.

    • First create a user account: www.informit.com/join
    • SAVE 40% When You Buy 2: www.informit.com/ruby
    • Add books of choice to Shopping Cart, then enter the code SAVEONRUBY during Checkout
    • (Includes FREE SHIPPING within the U.S.!)